Description: 'PromVector' is a custom scalar that is a one to one representation of the equivalent Prometheus API
type you can see here https://pkg.go.dev/github.com/prometheus/common/model?tab=doc#Vector .
This type is returned by numerous Prometheus graphQL queries.
Description: 'PromSample' is a custom scalar that is a one to one representation of the equivalent Prometheus API
type you can see here https://pkg.go.dev/github.com/prometheus/common/model?tab=doc#Sample .
This type is returned by some Prometheus graphQL queries.
Description: 'PromMatrix' is a custom scalar that is a one to one representation of the equivalent Prometheus API
type you can find more information on in the link over 'Vector'. Matrix is currently only returned
by one graphql endpoint.
Description: 'ChartStatus' is a custom scalar representing a map that holds chart status values with different keys associated to chart name,version,status
Description: 'proxy' is a custom scalar representing string value used for network proxy values.
The following are all valid values for proxy
https://auto:pass@autohostname.com:40,http://www.example.com,https://localhost:8080
https://localhost.test.com , https://test@t.com
Get all of the host->address mappings associated with a given cluster
clusterID: ID
getClusterActivationDetails
Activation
clusterID: ID
getSystemByRole
System
role: String
getOSConfig
OSConfig
clusterID: ID, nodeName: String
getAllOSConfigs
OSConfig
clusterID: ID
getClusterStatuses
Status
Get a cluster's statuses and helm resources deployed
clusterID: ID
getClusterDeploymentStatus
ChartStatus
Get the status of a cluster deployment
clusterID: ID, deploymentID: ID
getChart
Chart
Get a single Helm chart by name
chartName: String
getAllCharts
ChartList
Get all of the Helm charts available for deployment to any cluster
getBillOfMaterials
BillOfMaterials
getClusterDeployment
Deployment
Get a single deployment under a collector
clusterID: ID, deploymentID: ID
getAllClusterDeployments
Deployment
Get all of the deployments under a collector
clusterID: ID
getDeploymentEndpoint
Endpoint
Get an endpoint configured for a given deployment
clusterID: ID, deploymentID: ID, endpointID: ID
getAllDeploymentEndpoints
Endpoint
Get all of the endpoints configured for a given deployment
clusterID: ID, deploymentID: ID
getDeploymentEndpointCredentialsValidityPeriod
ValidityPeriod
Get EndpointCredential validity period
clusterID: ID, deploymentID: ID, endpointID: ID
getAWSRegions
String
Fetch list of AWS regions where we have images available
getRoleDeployments
Deployment
Get deployments to be installed on every cluster of a given role.
role: String
getRoleDeployment
Deployment
Get a role based deployment by ID.
deploymentID: ID
getAllCollectorsOverview
CollectorOverview
Get all collector overview data for the given role and time range
role: String, timeRange: TimeRange
getCollectorMetrics
CollectorMetrics
Get collector data flow metrics over a given time range
timeRange: TimeRange
getAggregateRateByCollector
AggregateRateByCollector
Get aggregated data flow rate metrics for a given collector over a given time range
clusterID: ID, timeRange: TimeRange
getFlowRate
FlowRate
Get flow rate metrics for a given collector over a given time range
clusterID: ID, timeRange: TimeRange
getLogLastSeenMetrics
LogLastSeenMetrics
Get last seen metrics for all available log sources for a given cluster. If no clusterId is specified, this will return all log sources metrics for all existing clusters
clusterID: ID
getDataSourceMetrics
DataSourceMetrics
Get metrics for all available data sources for a given cluster
in: GetDataSourceMetricsArguments
syslogMessageCountV2
SyslogMessageCountV2
Get syslog message counts for a given cluster or data source
in: SyslogMessageCountV2Arguments
getScheduledService
ScheduledService
ID: String
getClustersPasswordHash
String
Get a cluster's password hash
clusterID: ID
getDataCollectors
DataCollectorResult
Searches and/or aggregates on Data collectors cql schema
Description: The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Description: The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Description: CollectorOverview combines a Cluster with its corresponding lastSeen and averageRate metrics.
Check the CollectorMetrics type for more information on the latter.
Description: The hosts input structure represents a set ip address->hostname mappings used by a data collector.
These host alias mappings can be considered as analogous to an /etc/hosts file
Description: The aggregate flow rate metrics structure represents a set of collector data flow rate metrics.
Note that if custom host->address mappings, as returned by getHosts, are found they will be included or updated in the src_dns field.
Selecting this field yields the rough equivalent of: max(collector_last_seen) by (src_host,dst_host,dst_port,host_addr,src_dns,proto)
perFlowAverage
PromVector
Selecting this field yields the rough equivalent of: avg(rate(collector_conversation_bytes[TimeRange])) by (src_host,dst_host,dst_port,host_addr,src_dns,proto)
Description: LogLastSeenMetric contains all of the relevant metadata to identify a log source as well as a 'lastSeen' timestamp
which stores the last time that this log source was seen. A health status is also determined based on the recent ingest
rate from this log source and how it compares to its historical ingest rate. 1 standard deviation away from the historical
average is considered to be 'HEALTHY'. Anything greater than 1 but less than 2 standard deviations away is considered 'DEGRADED'.
Anything greater than 2 standard deviations is considered 'UNHEALTHY'. If a health status cannot be determined due to an
error or insufficient data then the returned health status will be 'UNKNOWN'.
Description: DataSourceMetric contains all of the relevant metadata to identify a log source as well as a 'lastSeen' timestamp
which stores the last time that this log source was seen. A health status is also determined based on the recent ingest
rate from this log source and how it compares to its historical ingest rate. 1 standard deviation away from the historical
average is considered to be 'HEALTHY'. Anything greater than 1 but less than 2 standard deviations away is considered 'DEGRADED'.
Anything greater than 2 standard deviations is considered 'UNHEALTHY'. If a health status cannot be determined due to an
error or insufficient data then the returned health status will be 'UNKNOWN'.
Description: The awsDetails input type contains the necessary identifying information for use with an AWS image download.
Deprecated, use AWSDetailsV2 with getClusterImageV2.
Description: The awsDetails input type contains the necessary identifying information for use with an AWS image download.
It is the strongly typed counterpart to AWSDetails.
Description: The gcpDetails input type contains the necessary identifying information for use with a GCP image download.
Deprecated, use GCPDetailsV2 with getClusterImageV2.
Description: The gcpDetails input type contains the necessary identifying information for use with a GCP image download.
It is the strongly typed counterpart to GCPDetails.
Description: GetDataSourceMetricsArguments allows specifying filter arguments when calling GetDataSourceMetrics
If no filters are specified, this will return all log sources metrics for all existing clusters and sources
Only for search queries. The cursor representing the page to return a base64 encoded '{offset} {count}' template. Normally you will get this value from a previous request. (previousCursor, nextCursor)
count
Int
How many records after the cursor (positive number) or before (negative number) should be returned, this allows setting the page size, or change it if needed. This only applies for search queries
Description: QLPageCursor describes cursor information that can be used for navigating the results on a per page fashion.
It will indicate more results by returning optionally returning previousCursor and nextCursor.
This object also returns the total count and the current page count, to ease logic in the UI.