{ "opencollection": "1.0.0", "info": { "name": "Jaeger Collector API (api_v2) CollectorService QueryService API", "version": "2.0" }, "items": [ { "info": { "name": "QueryService", "type": "folder" }, "items": [ { "info": { "name": "QueryService_GetDependencies", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:14268/api/v3/dependencies", "params": [ { "name": "startTime", "value": "", "type": "query", "description": "Required. The start time for the time range to search dependencies." }, { "name": "endTime", "value": "", "type": "query", "description": "Required. The end time for the time range to search dependencies." } ] } }, { "info": { "name": "QueryService_GetOperations", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:14268/api/v3/operations", "params": [ { "name": "service", "value": "", "type": "query", "description": "Required service name." }, { "name": "spanKind", "value": "", "type": "query", "description": "Optional span kind." } ] }, "docs": "GetOperations returns operation names." }, { "info": { "name": "QueryService_GetServices", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:14268/api/v3/services" }, "docs": "GetServices returns service names." }, { "info": { "name": "QueryService_FindTraceSummaries", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:14268/api/v3/trace-summaries", "params": [ { "name": "query.serviceName", "value": "", "type": "query", "description": "service_name filters spans generated by a specific service." }, { "name": "query.operationName", "value": "", "type": "query", "description": "operation_name filters spans by a specific operation / span name." }, { "name": "query.startTimeMin", "value": "", "type": "query", "description": "start_time_min is the start of the time interval (inclusive) for the query.\n Only traces with spans that started on or after this time will be returned.\n\n The HTTP API uses RFC-3339ns format.\n\n This field is required." }, { "name": "query.startTimeMax", "value": "", "type": "query", "description": "start_time_max is the end of the time interval (exclusive) for the query.\n Only traces with spans that started before this time will be returned.\n\n The HTTP API uses RFC-3339ns format.\n\n This field is required." }, { "name": "query.durationMin", "value": "", "type": "query", "description": "duration_min is the minimum duration of a span in the trace.\n Only traces with spans that lasted at least this long will be returned.\n\n The HTTP API uses Golang's time format (e.g., \"10s\")." }, { "name": "query.durationMax", "value": "", "type": "query", "description": "duration_max is the maximum duration of a span in the trace.\n Only traces with spans that lasted at most this long will be returned.\n\n The HTTP API uses Golang's time format (e.g., \"10s\")." }, { "name": "query.searchDepth", "value": "", "type": "query", "description": "search_depth defines the maximum search depth. Depending on the backend storage implementation,\n this may behave like an SQL `LIMIT` clause. However, some implementations might not support\n precise limits, and a larger value generally results in more traces being returned." }, { "name": "query.rawTraces", "value": "", "type": "query", "description": "If set to true, the response will exclude any enrichments to the trace, such as clock skew adjustments.\n The trace will be returned exactly as stored.\n\n This field is optional." } ] }, "docs": "FindTraceSummaries searches for traces matching the given query and streams\n back lightweight summary information for each matching trace. Each response\n chunk may contain one or more summaries. Use this instead of FindTraces when\n full span data is not required (e.g. search results page)." }, { "info": { "name": "QueryService_FindTraceSummaries", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:14268/api/v3/trace-summaries", "body": { "type": "json", "data": "{}" } }, "docs": "FindTraceSummaries searches for traces matching the given query and streams\n back lightweight summary information for each matching trace. Each response\n chunk may contain one or more summaries. Use this instead of FindTraces when\n full span data is not required (e.g. search results page)." }, { "info": { "name": "QueryService_FindTraces", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:14268/api/v3/traces", "params": [ { "name": "query.serviceName", "value": "", "type": "query", "description": "service_name filters spans generated by a specific service." }, { "name": "query.operationName", "value": "", "type": "query", "description": "operation_name filters spans by a specific operation / span name." }, { "name": "query.startTimeMin", "value": "", "type": "query", "description": "start_time_min is the start of the time interval (inclusive) for the query.\n Only traces with spans that started on or after this time will be returned.\n\n The HTTP API uses RFC-3339ns format.\n\n This field is required." }, { "name": "query.startTimeMax", "value": "", "type": "query", "description": "start_time_max is the end of the time interval (exclusive) for the query.\n Only traces with spans that started before this time will be returned.\n\n The HTTP API uses RFC-3339ns format.\n\n This field is required." }, { "name": "query.durationMin", "value": "", "type": "query", "description": "duration_min is the minimum duration of a span in the trace.\n Only traces with spans that lasted at least this long will be returned.\n\n The HTTP API uses Golang's time format (e.g., \"10s\")." }, { "name": "query.durationMax", "value": "", "type": "query", "description": "duration_max is the maximum duration of a span in the trace.\n Only traces with spans that lasted at most this long will be returned.\n\n The HTTP API uses Golang's time format (e.g., \"10s\")." }, { "name": "query.searchDepth", "value": "", "type": "query", "description": "search_depth defines the maximum search depth. Depending on the backend storage implementation,\n this may behave like an SQL `LIMIT` clause. However, some implementations might not support\n precise limits, and a larger value generally results in more traces being returned." }, { "name": "query.rawTraces", "value": "", "type": "query", "description": "If set to true, the response will exclude any enrichments to the trace, such as clock skew adjustments.\n The trace will be returned exactly as stored.\n\n This field is optional." } ] }, "docs": "FindTraces searches for traces.\n See GetTrace for JSON unmarshalling." }, { "info": { "name": "QueryService_FindTracesPost", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:14268/api/v3/traces", "body": { "type": "json", "data": "{}" } }, "docs": "FindTraces searches for traces.\n See GetTrace for JSON unmarshalling." }, { "info": { "name": "QueryService_GetTrace", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:14268/api/v3/traces/:traceId", "params": [ { "name": "traceId", "value": "", "type": "path", "description": "Hex encoded 64 or 128 bit trace ID." }, { "name": "startTime", "value": "", "type": "query", "description": "Optional. The start time to search trace ID." }, { "name": "endTime", "value": "", "type": "query", "description": "Optional. The end time to search trace ID." }, { "name": "rawTraces", "value": "", "type": "query", "description": "Optional. If set to true, the response will not include any\n enrichments to the trace, such as clock skew adjustment.\n Instead, the trace will be returned exactly as stored." } ] }, "docs": "GetTrace returns a single trace.\n Note that the JSON response over HTTP is wrapped into result envelope \"{\"result\": ...}\"\n It means that the JSON response cannot be directly unmarshalled using JSONPb.\n This can be fixed by first parsing into user-defined envelope with standard JSON library\n or string manipulation to remove the envelope. Alternatively generate objects using OpenAPI." } ] } ], "bundled": true }