TempoQuery🔗
Definition🔗
class TempoQuery implements \JsonSerializable, \Grafana\Foundation\Cog\Dataquery
{
/**
* 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.
*/
public string $refId;
/**
* If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.
*/
public ?bool $hide;
/**
* Specify the query flavor
* TODO make this required and give it a default
*/
public ?string $queryType;
/**
* TraceQL query or trace ID
*/
public ?string $query;
/**
* @deprecated Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true
*/
public ?string $search;
/**
* @deprecated Query traces by service name
*/
public ?string $serviceName;
/**
* @deprecated Query traces by span name
*/
public ?string $spanName;
/**
* @deprecated Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms
*/
public ?string $minDuration;
/**
* @deprecated Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms
*/
public ?string $maxDuration;
/**
* 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.
* @var string|array<string>|null
*/
public $serviceMapQuery;
/**
* Use service.namespace in addition to service.name to uniquely identify a service.
*/
public ?bool $serviceMapIncludeNamespace;
/**
* Defines the maximum number of traces that are returned from Tempo
*/
public ?int $limit;
/**
* Defines the maximum number of spans per spanset that are returned from Tempo
*/
public ?int $spss;
/**
* @var array<\Grafana\Foundation\Tempo\TraceqlFilter>
*/
public array $filters;
/**
* Filters that are used to query the metrics summary
* @var array<\Grafana\Foundation\Tempo\TraceqlFilter>|null
*/
public ?array $groupBy;
/**
* The type of the table that is used to display the search results
*/
public ?\Grafana\Foundation\Tempo\SearchTableType $tableType;
/**
* For mixed data sources the selected datasource is on the query level.
* For non mixed scenarios this is undefined.
* TODO find a better way to do this ^ that's friendly to schema
* TODO this shouldn't be unknown but DataSourceRef | null
*/
public ?\Grafana\Foundation\Dashboard\DataSourceRef $datasource;
/**
* For metric queries, the step size to use
*/
public ?string $step;
}
Methods🔗
fromArray🔗
Builds this object from an array.
This function is meant to be used with the return value of json_decode($json, true)
.
jsonSerialize🔗
Returns the data representing this object, preparing it for JSON serialization with json_encode()
.
dataqueryType🔗
Returns the type of this dataquery object.