EXPAND ALL
  • Home
Open Source Docs

PXL Functions

Scalar Functions

FunctionArgumentsDescription
_exec_host_num_cpus
-> INT64
Get the number of CPUs on the host machine.
_exec_hostname
-> STRING
Get the hostname of the machine.
_match_regex_rule
STRING, STRING -> STRING
Check for a match to a json of regex pattern rules in a string.
abs
FLOAT64 -> FLOAT64
INT64 -> INT64
Computes absolute value
add
INT64, INT64 -> INT64
FLOAT64, FLOAT64 -> FLOAT64
STRING, STRING -> STRING
FLOAT64, INT64 -> FLOAT64
INT64, FLOAT64 -> FLOAT64
TIME64NS, INT64 -> TIME64NS
INT64, TIME64NS -> TIME64NS
Arithmetically add the arguments or concatenate the strings.
amqp_frame_type_name
INT64 -> STRING
Convert a AMQP frame type to its name.
amqp_method_name
INT64, INT64 -> STRING
Convert a AMQP method id to its name.
approxEqual
FLOAT64, FLOAT64 -> BOOLEAN
Return whether the two values are approximately equal.
asid
-> INT64
Get the agent ID.
atoi
STRING, INT64 -> INT64
Convert a string to an integer.
bin
INT64, INT64 -> INT64
TIME64NS, TIME64NS -> TIME64NS
INT64, TIME64NS -> INT64
TIME64NS, INT64 -> TIME64NS
FLOAT64, INT64 -> INT64
Rounds value to the nearest multiple.
bytes_to_hex
STRING -> STRING
Convert an input bytes in hex string.
ceil
FLOAT64 -> INT64
Compute the ceiling of the value.
cidrs_contain_ip
STRING, STRING -> BOOLEAN
Determine whether an IP is contained in a set of CIDR ranges.
container_id_to_start_time
STRING -> TIME64NS
Get the start time of a container from its ID.
container_id_to_status
STRING -> STRING
Get the status of the container given the container ID.
container_id_to_stop_time
STRING -> TIME64NS
Get the stop time of a container from its ID.
container_name_to_container_id
STRING -> STRING
Get the id of a container from its name.
container_name_to_start_time
STRING -> TIME64NS
Get the start time of a container from its name.
container_name_to_stop_time
STRING -> TIME64NS
Get the stop time of a container from its name.
contains
STRING, STRING -> BOOLEAN
Returns whether the first string contains the second string.
deployment_id_to_deployment_name
STRING -> STRING
Get the Deployment Name from a Deployment ID.
deployment_id_to_namespace
STRING -> STRING
Get the namespace of a Deployment from its ID.
deployment_id_to_start_time
STRING -> TIME64NS
Get the start time of a Deployment from its ID.
deployment_id_to_status
STRING -> STRING
Get the status of a Deployment from its ID.
deployment_id_to_stop_time
STRING -> TIME64NS
Get the stop time of a Deployment from its ID.
deployment_name_to_deployment_id
STRING -> STRING
Get the Deployment ID from a Deployment name.
deployment_name_to_namespace
STRING -> STRING
Get the namespace of a Deployment from its name.
deployment_name_to_start_time
STRING -> TIME64NS
Get the start time of a Deployment from its name.
deployment_name_to_status
STRING -> STRING
Get the status of a Deployment from its name.
deployment_name_to_stop_time
STRING -> TIME64NS
Get the stop time of a Deployment from its name.
divide
INT64, INT64 -> FLOAT64
FLOAT64, INT64 -> FLOAT64
INT64, FLOAT64 -> FLOAT64
FLOAT64, FLOAT64 -> FLOAT64
Arithmetically divide the two arguments.
equal
INT64, INT64 -> BOOLEAN
STRING, STRING -> BOOLEAN
BOOLEAN, BOOLEAN -> BOOLEAN
TIME64NS, TIME64NS -> BOOLEAN
UINT128, UINT128 -> BOOLEAN
BOOLEAN, INT64 -> BOOLEAN
INT64, BOOLEAN -> BOOLEAN
INT64, FLOAT64 -> BOOLEAN
FLOAT64, INT64 -> BOOLEAN
FLOAT64, FLOAT64 -> BOOLEAN
Returns whether the values are equal.
exp
FLOAT64 -> FLOAT64
INT64 -> FLOAT64
Computes e^x
find
STRING, STRING -> INT64
Find the index of the first occurrence of the substring.
floor
FLOAT64 -> INT64
Compute the floor of the value.
get_cidrs
-> STRING
Get the pod/service CIDRs for the cluster.
greaterThan
INT64, INT64 -> BOOLEAN
TIME64NS, TIME64NS -> BOOLEAN
FLOAT64, FLOAT64 -> BOOLEAN
STRING, STRING -> BOOLEAN
Compare whether the first argument is greater than the second argument.
greaterThanEqual
INT64, INT64 -> BOOLEAN
FLOAT64, FLOAT64 -> BOOLEAN
STRING, STRING -> BOOLEAN
TIME64NS, TIME64NS -> BOOLEAN
Compare whether the first argument is greater than or equal to the second argument.
grpc_status_code_to_str
INT64 -> STRING
Converts the GRPC status code into a readable string error.
has_service_id
STRING, STRING -> BOOLEAN
Determine if a particular service ID is present
has_service_name
STRING, STRING -> BOOLEAN
Determine if a particular service name is present
has_value
STRING, STRING -> BOOLEAN
Determine if a value is present in an array.
hex_to_ascii
STRING -> STRING
Convert an input hex sequence in ASCII to bytes.
http_resp_message
INT64 -> STRING
Convert an HTTP response code to its corresponding message.
int64_to_time
INT64 -> TIME64NS
Converts a int64 value to a time
invert
INT64 -> INT64
Invert the bits of the given value.
ip_to_pod_id
STRING -> STRING
Convert IP address to the kubernetes pod ID that runs the backing service.
ip_to_service_id
STRING -> STRING
Get the service ID for a given IP.
itoa
INT64 -> STRING
Convert an integer into a string.
kafka_api_key_name
INT64 -> STRING
Convert a Kafka API key to its name.
length
STRING -> INT64
Returns the length of the string
lessThan
INT64, INT64 -> BOOLEAN
TIME64NS, TIME64NS -> BOOLEAN
FLOAT64, FLOAT64 -> BOOLEAN
STRING, STRING -> BOOLEAN
Returns which value is less than the other.
lessThanEqual
INT64, INT64 -> BOOLEAN
FLOAT64, FLOAT64 -> BOOLEAN
TIME64NS, TIME64NS -> BOOLEAN
STRING, STRING -> BOOLEAN
Returns which value is less than or equal to the the other.
ln
FLOAT64 -> FLOAT64
INT64 -> FLOAT64
Computes the natural log.
log
FLOAT64, FLOAT64 -> FLOAT64
FLOAT64, INT64 -> FLOAT64
INT64, FLOAT64 -> FLOAT64
INT64, INT64 -> FLOAT64
Computes the log base (b).
log10
FLOAT64 -> FLOAT64
INT64 -> FLOAT64
Computes the log base-10.
log2
FLOAT64 -> FLOAT64
INT64 -> FLOAT64
Computes the log base-2.
logicalAnd
INT64, INT64 -> BOOLEAN
BOOLEAN, BOOLEAN -> BOOLEAN
Boolean ANDs the passed in values.
logicalNot
INT64 -> BOOLEAN
BOOLEAN -> BOOLEAN
Boolean NOTs the passed in value.
logicalOr
INT64, INT64 -> BOOLEAN
BOOLEAN, BOOLEAN -> BOOLEAN
Boolean ORs the passed in values.
modulo
TIME64NS, INT64 -> INT64
TIME64NS, TIME64NS -> INT64
INT64, TIME64NS -> INT64
INT64, INT64 -> INT64
Calculates the remainder of the division of the two numbers
multiply
INT64, INT64 -> INT64
FLOAT64, FLOAT64 -> FLOAT64
FLOAT64, INT64 -> FLOAT64
INT64, FLOAT64 -> FLOAT64
Multiplies the arguments.
mysql_command_name
INT64 -> STRING
Convert a MySQL command code to its name.
negate
INT64 -> INT64
FLOAT64 -> FLOAT64
Negates the passed in value.
normalize_mysql
STRING, INT64 -> STRING
Normalizes MySQL queries by replacing constants with placeholders.
normalize_pgsql
STRING, STRING -> STRING
Normalizes PostgresSQL queries by replacing constants with placeholders.
notEqual
INT64, INT64 -> BOOLEAN
STRING, STRING -> BOOLEAN
BOOLEAN, BOOLEAN -> BOOLEAN
TIME64NS, TIME64NS -> BOOLEAN
UINT128, UINT128 -> BOOLEAN
BOOLEAN, INT64 -> BOOLEAN
INT64, BOOLEAN -> BOOLEAN
INT64, FLOAT64 -> BOOLEAN
FLOAT64, INT64 -> BOOLEAN
Returns whether the values are not equal.
nslookup
STRING -> STRING
Perform a DNS lookup for the value (experimental).
pluck
STRING, STRING -> STRING
Grabs the value for the key value the serialized JSON string and returns as a string.
pluck_array
STRING, INT64 -> STRING
Grabs the ith value in the array from the serialized JSON string and returns as a string.
pluck_float64
STRING, STRING -> FLOAT64
Grabs the value for the key from the serialized JSON string and returns as a float.
pluck_int64
STRING, STRING -> INT64
Grabs the value for the key from the serialized JSON string and returns as an int.
pod_id_to_deployment_id
STRING -> STRING
Get the ID of the Deployment which controls the pod with pod ID.
pod_id_to_deployment_name
STRING -> STRING
Get the name of the Deployment which controls the pod with pod ID.
pod_id_to_namespace
STRING -> STRING
Get the Kubernetes namespace from a pod ID.
pod_id_to_node_name
STRING -> STRING
Get the name of the node a pod ID is running on.
pod_id_to_owner_references
STRING -> STRING
Get the owner references for a given pod ID.
pod_id_to_pod_labels
STRING -> STRING
Get labels of a pod from its pod ID.
pod_id_to_pod_name
STRING -> STRING
Get the name of a pod from its pod ID.
pod_id_to_replicaset_id
STRING -> STRING
Get the ID of the Replica Set which controls the pod with pod ID.
pod_id_to_replicaset_name
STRING -> STRING
Get the name of the Replica Set which controls the pod with pod ID.
pod_id_to_service_id
STRING -> STRING
Get the service ID for a given pod ID.
pod_id_to_service_name
STRING -> STRING
Get the service name for a given pod ID.
pod_id_to_start_time
STRING -> TIME64NS
Get the start time of a pod from its ID.
pod_id_to_stop_time
STRING -> TIME64NS
Get the stop time of a pod from its ID.
pod_name_to_deployment_id
STRING -> STRING
Get the ID of the Deployment which controls the pod with the specified pod name.
pod_name_to_deployment_name
STRING -> STRING
Get the name of the Deployment which controls the pod with the specified pod name.
pod_name_to_namespace
STRING -> STRING
Get the Kubernetes namespace from a pod name.
pod_name_to_owner_references
STRING -> STRING
Get the owner references for a given pod name.
pod_name_to_pod_id
STRING -> STRING
Get the id of a pod from its name.
pod_name_to_pod_ip
STRING -> STRING
Get the IP address of a pod from its name.
pod_name_to_replicaset_id
STRING -> STRING
Get the ID of the Replica Set which controls the pod with the specified pod name.
pod_name_to_replicaset_name
STRING -> STRING
Get the name of the Replica Set which controls the pod with the specified pod name.
pod_name_to_service_id
STRING -> STRING
Get the service ID for a given pod name.
pod_name_to_service_name
STRING -> STRING
Get the service name for a given pod name.
pod_name_to_start_time
STRING -> TIME64NS
Get the start time of a pod from its name.
pod_name_to_status
STRING -> STRING
Get status information about the given pod.
pod_name_to_stop_time
STRING -> TIME64NS
Get the stop time of a pod from its name.
pow
FLOAT64, FLOAT64 -> FLOAT64
FLOAT64, INT64 -> FLOAT64
INT64, FLOAT64 -> FLOAT64
INT64, INT64 -> FLOAT64
Computes the power function.
protocol_name
INT64 -> STRING
Convert a protocol code to its corresponding name.
redact_pii_best_effort
STRING -> STRING
Make a best effort to redact Personally Identifiable Information (PII).
regex_match
STRING, STRING -> BOOLEAN
Check for a match to a regex pattern in a string.
replace
STRING, STRING, STRING -> STRING
Replace all matches of a regex pattern in a string with another string.
replicaset_id_to_deployment_id
STRING -> STRING
Get the Deployment ID of a Replica Set from its ID.
replicaset_id_to_deployment_name
STRING -> STRING
Get the Deployment name of a Replica Set from its ID.
replicaset_id_to_namespace
STRING -> STRING
Get the namespace of a Replica Set from its ID.
replicaset_id_to_owner_references
STRING -> STRING
Get the owner references of a Replica Set from its ID.
replicaset_id_to_replicaset_name
STRING -> STRING
Get the Replica Set Name from a Replica Set ID.
replicaset_id_to_start_time
STRING -> TIME64NS
Get the start time of a Replica Set from its ID.
replicaset_id_to_status
STRING -> STRING
Get the status of a Replica Set from its ID.
replicaset_id_to_stop_time
STRING -> TIME64NS
Get the stop time of a Replica Set from its ID.
replicaset_name_to_deployment_id
STRING -> STRING
Get the Deployment ID of a Replica Set from its name.
replicaset_name_to_deployment_name
STRING -> STRING
Get the Deployment name of a Replica Set from its name.
replicaset_name_to_namespace
STRING -> STRING
Get the namespace of a Replica Set from its name.
replicaset_name_to_owner_references
STRING -> STRING
Get the owner references of a Replica Set from its name.
replicaset_name_to_replicaset_id
STRING -> STRING
Get the Replica Set ID from a Replica Set name.
replicaset_name_to_start_time
STRING -> TIME64NS
Get the start time of a Replica Set from its name.
replicaset_name_to_status
STRING -> STRING
Get the status of a Replica Set from its name.
replicaset_name_to_stop_time
STRING -> TIME64NS
Get the stop time of a Replica Set from its name.
round
FLOAT64, INT64 -> STRING
Rounds the float to the nearest decimal places.
select
BOOLEAN, BOOLEAN, BOOLEAN -> BOOLEAN
BOOLEAN, INT64, INT64 -> INT64
BOOLEAN, FLOAT64, FLOAT64 -> FLOAT64
BOOLEAN, TIME64NS, TIME64NS -> TIME64NS
BOOLEAN, STRING, STRING -> STRING
Selects value based on the first argument.
service_id_to_cluster_ip
STRING -> STRING
Convert the Kubernetes service ID to its cluster IP.
service_id_to_external_ips
STRING -> STRING
Convert the Kubernetes service ID to its external IP addresses.
service_id_to_service_name
STRING -> STRING
Convert the Kubernetes service ID to service name.
service_name_to_namespace
STRING -> STRING
Gets the namespace from the service name.
service_name_to_service_id
STRING -> STRING
Convert the service name to the service ID.
sqrt
FLOAT64 -> FLOAT64
INT64 -> FLOAT64
Compute the sqrt
strip_prefix
STRING, STRING -> STRING
Strips the specified prefix from the string.
substring
STRING, INT64, INT64 -> STRING
Returns the specified substring from the string
subtract
INT64, INT64 -> INT64
FLOAT64, FLOAT64 -> FLOAT64
FLOAT64, INT64 -> FLOAT64
INT64, FLOAT64 -> FLOAT64
TIME64NS, INT64 -> TIME64NS
TIME64NS, TIME64NS -> INT64
INT64, TIME64NS -> INT64
Arithmetically subtract the first argument by the second argument.
time_to_int64
TIME64NS -> INT64
Converts a time value to an int64 value
tolower
STRING -> STRING
Transforms all uppercase ascii characters in the string to lowercase.
toupper
STRING -> STRING
Transforms all lowercase ascii characters in the string to uppercase.
trim
STRING -> STRING
Trim ascii whitespace from before and after the string content.
upid
INT64, INT64, INT64 -> UINT128
INT64, INT64 -> UINT128
Convert a pid, start_time pair to a UPID.
upid_to_asid
UINT128 -> INT64
Get the Pixie Agent ID from the UPID.
upid_to_cmdline
UINT128 -> STRING
Get the command line arguments used to start a UPID.
upid_to_container_id
UINT128 -> STRING
Get the Kubernetes container ID from a UPID.
upid_to_container_name
UINT128 -> STRING
Get the Kubernetes container name from a UPID.
upid_to_deployment_id
UINT128 -> STRING
Get the Deployment ID from a UPID.
upid_to_deployment_name
UINT128 -> STRING
Get the Deployment Name from a UPID.
upid_to_hostname
UINT128 -> STRING
Get the Hostname from a UPID.
upid_to_namespace
UINT128 -> STRING
Get the Kubernetes namespace from a UPID.
upid_to_node_name
UINT128 -> STRING
Get the Node Name from a UPID.
upid_to_pid
UINT128 -> INT64
Get the PID of the process for the given UPID.
upid_to_pod_id
UINT128 -> STRING
Get the Kubernetes Pod ID from a UPID.
upid_to_pod_name
UINT128 -> STRING
Get the Kubernetes Pod Name from a UPID.
upid_to_pod_qos
UINT128 -> STRING
Get the Kubernetes QOS class for the UPID.
upid_to_pod_status
UINT128 -> STRING
Get status information about the pod of a UPID.
upid_to_replicaset_id
UINT128 -> STRING
Get the Replica Set ID from a UPID.
upid_to_replicaset_name
UINT128 -> STRING
Get the Replica Set Name from a UPID.
upid_to_service_id
UINT128 -> STRING
Get the Service ID from a UPID.
upid_to_service_name
UINT128 -> STRING
Get the Service Name from a UPID.
upid_to_string
UINT128 -> STRING
Get a stringified version of the UPID.
uri_parse
STRING -> STRING
Parses the URI into it's component parts and returns the parts as a JSON string.
uri_recompose
STRING, STRING, STRING, INT64, STRING, STRING, STRING -> STRING
Recomposes the URI parts int a URI.
vizier_id
-> STRING
Get the ID of the cluster.
vizier_name
-> STRING
Get the name of the cluster.

Aggregate Functions

FunctionArgumentsDescription
any
BOOLEAN -> BOOLEAN
INT64 -> INT64
FLOAT64 -> FLOAT64
TIME64NS -> TIME64NS
STRING -> STRING
UINT128 -> UINT128
Picks any single value.
count
FLOAT64 -> INT64
INT64 -> INT64
TIME64NS -> INT64
BOOLEAN -> INT64
STRING -> INT64
UINT128 -> INT64
Returns number of rows in the aggregate group.
max
FLOAT64 -> FLOAT64
INT64 -> INT64
TIME64NS -> TIME64NS
Returns the maximum in the group.
mean
FLOAT64 -> FLOAT64
INT64 -> FLOAT64
BOOLEAN -> FLOAT64
Calculate the arithmetic mean.
min
FLOAT64 -> FLOAT64
INT64 -> INT64
TIME64NS -> TIME64NS
Returns the minimum in the group.
quantiles
INT64 -> STRING
FLOAT64 -> STRING
Approximates the distribution of the aggregated data.
sum
FLOAT64 -> FLOAT64
INT64 -> INT64
BOOLEAN -> INT64
Calculate the arithmetic sum of the grouped values.
This site uses cookies to provide you with a better user experience. By using Pixie, you consent to our use of cookies.