Parameters and Operators
Traceable’s Explorer lets you build powerful queries using a combination of operators and filter parameters. These allow you to narrow down trace data based on attributes, such as service name, status code, request method, or content within payloads.
This page provides an overview of commonly used operators and parameters available in the Explorer’s query bar. While not exhaustive, the examples here will help you understand how to structure your filters, use supported operators, and combine them effectively to analyze API traffic.
Use this topic as a reference to:
Understand the syntax and structure of supported filters
Learn which operators are supported (e.g.,
=,!=,IN,regexp_like)See examples of how to apply these filters in practical scenarios
Filter Parameters
The following tables explain some filter parameters for Endpoint traces and spans.
Endpoint Traces
API exit call
Number of outbound calls made by the API Endpoint
Calls
Number of calls to the API Endpoint
Duration
The time spent within the boundary of a service containing the API Endpoint is the time between the entry span into the service and the exit span out of the service.
End time
The end time of the segment of the trace
Endpoint ID
The ID of the API Endpoint this trace segment belongs to
Endpoint Name
Name of the API Endpoint this trace segment belongs to
Endpoint Trace ID
The span ID corresponds to the entry span, which is the starting span of the Endpoint trace segment.
Environment
All the data visible is scoped under the selected environment. But if you select AllEnvironments, this shows the environment corresponding to the trace segment.
Error count
Count of errors in the given API trace
HTTP Method
HTTP Methods, such as GET/POST/PUT/DELETE, and others.
IP Address
Client's IP address
Is Endpoint PII
True if the endpoint corresponding to the trace segment has any sensitive information/parameters.
Protocol
HTTP or GRPC
Request Body
Contains the API request for the given API
Request Content-Type
Content-type request header
Service ID
The ID of the Service that owns the API Endpoint trace this segment belongs to
Service Name
Name of the Service that owns the API Endpoint this trace segment belongs to
Session ID
User session ID in which the current operation (that resulted in the trace) was performed
Start time
The start time of the segment of the trace
Trace ID
The trace ID of the trace that this segment is part of
User ID
The username or client_id was extracted from the access token or Authorization header in the inbound request from outside the system.
User Role
The client's actual or assumed role is making the request extracted from the token or application security context.
User Scope
Scopes or granted authorities the client currently possesses were extracted from the token or application security context. The value would come from the scope associated with an OAuth 2.0 Access Token or an attribute value in a SAML 2.0 Assertion.
Spans
Duration
The time duration for the span
Endtime
The finish time for the span
Error Count
Count the number of error occurrences in the given span
Parent Span ID
Span ID for the parent span
Protocol
One of HTTP, HTTPS, GRPC, REDIS, MONGO, JDBC, RABBIT_MQ protocols
Request Body
Contains the API request for the given API
Request Content-Type
Content-type request header
Request Params
The request parameters
Request size
The size of the request
Request Headers
The request headers
Response Content Type
Content-type response header
Response Headers
The response headers
Response Size
The size of the response
Service ID
The ID of the service corresponding to the given span
Service Name
Name of the service corresponding to the given span
Span ID
The identifier for the span
Span Name
The name for the span
Start Time
The time when the span event started
Tags
The key-value attributes for the span. It captures various events or metadata about the span
Trace ID
An Identifier for the trace that this span belongs to
Operators
The following table lists the various operators with their descriptions and examples.
=
This operator tests for an exact match and is case-sensitive. When used against an array, it tests for at least one matching value. It can be used against a particular map entry by including a key-value pair to test against, to be included as part of the field declaration; however, it cannot be used against a map itself.
String, Number, Boolean, Map Value, String Array
Bot IP = true
User Roles = Developer
Request Headers.x-forwarded-for = 1.2.3.4
!=
This operator is used as a negation of =. For arrays, this checks that there are no matching values.
String, Number, Boolean, Map Value, String Array
Bot IP != true
User Roles != Developer
Request Headers.x-forwarded-for != 1.2.3.4
IN
This operator is like =, except that it accepts a comma-separated list of allowed matches.
String, Number, Boolean, Map Value, String Array
Service Name IN dataservice, loginservice
User Roles IN developer, analyst
Request Headers.x-forwarded-for IN 1.2.3.4, 5.6.7.8
NOT_IN
Negation of IN. For arrays, this checks that there are no matching values.
String, Number, Boolean, Map Value, String Array
Service Name NOT_IN dataservice, loginservice
User Roles NOT_IN developer, analyst
Request Headers.x-forwarded-for NOT_IN 1.2.3.4, 5.6.7.8
~
Evaluates the provided RE2-compliant regular expression for any matches.
String, Map Value, String Array
Service Name ~ ^data
Request Headers.x-forwarded-for ~ 10.10.10.\d{1,3}
<
Less than
Number
Duration < 10
>
Greater than
Number
Duration > 10
<=
Less than or equal to
Number
Duration <= 10
>=
Greater than or equal to
Number
Duration >= 10
CONTAINS
This operator checks if the string contains the provided substring. The operator is case-insensitive. For arrays, the operator checks if there are any matching values.
String, String Array
Service Name CONTAINS auth
CONTAINS_KEY
This operator checks if the map contains a key with the provided name. The operator is case-sensitive.
Map
Request Headers CONTAINS_KEY x-forwarded-for
CONTAINS_KEY_LIKE
This operator checks if the map contains a key that matches the provided regular expression. The operator is case-insensitive.
Map
Request Headers CONTAINS_KEY_LIKE forward.*
NOT_CONTAINS_KEY
This operator checks if the map contains no key that exactly matches the provided value. The operator is case-sensitive.
Map
Request Headers NOT_CONTAINS_KEY x-forwarded-for
Last updated
Was this helpful?