1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
// This file is @generated by prost-build.
/// A trace describes how long it takes for an application to perform an
/// operation. It consists of a set of spans, each of which represent a single
/// timed event within the operation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Trace {
/// Project ID of the Cloud project where the trace data is stored.
#[prost(string, tag = "1")]
pub project_id: ::prost::alloc::string::String,
/// Globally unique identifier for the trace. This identifier is a 128-bit
/// numeric value formatted as a 32-byte hex string. For example,
/// `382d4f4c6b7bb2f4a972559d9085001d`.
#[prost(string, tag = "2")]
pub trace_id: ::prost::alloc::string::String,
/// Collection of spans in the trace.
#[prost(message, repeated, tag = "3")]
pub spans: ::prost::alloc::vec::Vec<TraceSpan>,
}
/// List of new or updated traces.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Traces {
/// List of traces.
#[prost(message, repeated, tag = "1")]
pub traces: ::prost::alloc::vec::Vec<Trace>,
}
/// A span represents a single timed event within a trace. Spans can be nested
/// and form a trace tree. Often, a trace contains a root span that describes the
/// end-to-end latency of an operation and, optionally, one or more subspans for
/// its suboperations. Spans do not need to be contiguous. There may be gaps
/// between spans in a trace.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TraceSpan {
/// Identifier for the span. Must be a 64-bit integer other than 0 and
/// unique within a trace. For example, `2205310701640571284`.
#[prost(fixed64, tag = "1")]
pub span_id: u64,
/// Distinguishes between spans generated in a particular context. For example,
/// two spans with the same name may be distinguished using `RPC_CLIENT`
/// and `RPC_SERVER` to identify queueing latency associated with the span.
#[prost(enumeration = "trace_span::SpanKind", tag = "2")]
pub kind: i32,
/// Name of the span. Must be less than 128 bytes. The span name is sanitized
/// and displayed in the Stackdriver Trace tool in the
/// Google Cloud Platform Console.
/// The name may be a method name or some other per-call site name.
/// For the same executable and the same call point, a best practice is
/// to use a consistent name, which makes it easier to correlate
/// cross-trace spans.
#[prost(string, tag = "3")]
pub name: ::prost::alloc::string::String,
/// Start time of the span in nanoseconds from the UNIX epoch.
#[prost(message, optional, tag = "4")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// End time of the span in nanoseconds from the UNIX epoch.
#[prost(message, optional, tag = "5")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. ID of the parent span, if any.
#[prost(fixed64, tag = "6")]
pub parent_span_id: u64,
/// Collection of labels associated with the span. Label keys must be less than
/// 128 bytes. Label values must be less than 16 kilobytes (10MB for
/// `/stacktrace` values).
///
/// Some predefined label keys exist, or you may create your own. When creating
/// your own, we recommend the following formats:
///
/// * `/category/product/key` for agents of well-known products (e.g.
/// `/db/mongodb/read_size`).
/// * `short_host/path/key` for domain-specific keys (e.g.
/// `foo.com/myproduct/bar`)
///
/// Predefined labels include:
///
/// * `/agent`
/// * `/component`
/// * `/error/message`
/// * `/error/name`
/// * `/http/client_city`
/// * `/http/client_country`
/// * `/http/client_protocol`
/// * `/http/client_region`
/// * `/http/host`
/// * `/http/method`
/// * `/http/path`
/// * `/http/redirected_url`
/// * `/http/request/size`
/// * `/http/response/size`
/// * `/http/route`
/// * `/http/status_code`
/// * `/http/url`
/// * `/http/user_agent`
/// * `/pid`
/// * `/stacktrace`
/// * `/tid`
#[prost(btree_map = "string, string", tag = "7")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
}
/// Nested message and enum types in `TraceSpan`.
pub mod trace_span {
/// Type of span. Can be used to specify additional relationships between spans
/// in addition to a parent/child relationship.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum SpanKind {
/// Unspecified.
Unspecified = 0,
/// Indicates that the span covers server-side handling of an RPC or other
/// remote network request.
RpcServer = 1,
/// Indicates that the span covers the client-side wrapper around an RPC or
/// other remote request.
RpcClient = 2,
}
impl SpanKind {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
SpanKind::Unspecified => "SPAN_KIND_UNSPECIFIED",
SpanKind::RpcServer => "RPC_SERVER",
SpanKind::RpcClient => "RPC_CLIENT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"SPAN_KIND_UNSPECIFIED" => Some(Self::Unspecified),
"RPC_SERVER" => Some(Self::RpcServer),
"RPC_CLIENT" => Some(Self::RpcClient),
_ => None,
}
}
}
}
/// The request message for the `ListTraces` method. All fields are required
/// unless specified.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTracesRequest {
/// Required. ID of the Cloud project where the trace data is stored.
#[prost(string, tag = "1")]
pub project_id: ::prost::alloc::string::String,
/// Optional. Type of data returned for traces in the list. Default is
/// `MINIMAL`.
#[prost(enumeration = "list_traces_request::ViewType", tag = "2")]
pub view: i32,
/// Optional. Maximum number of traces to return. If not specified or <= 0, the
/// implementation selects a reasonable value. The implementation may
/// return fewer traces than the requested page size.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// Token identifying the page of results to return. If provided, use the
/// value of the `next_page_token` field from a previous request.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
/// Start of the time interval (inclusive) during which the trace data was
/// collected from the application.
#[prost(message, optional, tag = "5")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// End of the time interval (inclusive) during which the trace data was
/// collected from the application.
#[prost(message, optional, tag = "6")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. A filter against labels for the request.
///
/// By default, searches use prefix matching. To specify exact match, prepend
/// a plus symbol (`+`) to the search term.
/// Multiple terms are ANDed. Syntax:
///
/// * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root
/// span starts with `NAME_PREFIX`.
/// * `+root:NAME` or `+NAME`: Return traces where any root span's name is
/// exactly `NAME`.
/// * `span:NAME_PREFIX`: Return traces where any span starts with
/// `NAME_PREFIX`.
/// * `+span:NAME`: Return traces where any span's name is exactly
/// `NAME`.
/// * `latency:DURATION`: Return traces whose overall latency is
/// greater or equal to than `DURATION`. Accepted units are nanoseconds
/// (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For
/// example, `latency:24ms` returns traces whose overall latency
/// is greater than or equal to 24 milliseconds.
/// * `label:LABEL_KEY`: Return all traces containing the specified
/// label key (exact match, case-sensitive) regardless of the key:value
/// pair's value (including empty values).
/// * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified
/// label key (exact match, case-sensitive) whose value starts with
/// `VALUE_PREFIX`. Both a key and a value must be specified.
/// * `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair
/// exactly matching the specified text. Both a key and a value must be
/// specified.
/// * `method:VALUE`: Equivalent to `/http/method:VALUE`.
/// * `url:VALUE`: Equivalent to `/http/url:VALUE`.
#[prost(string, tag = "7")]
pub filter: ::prost::alloc::string::String,
/// Optional. Field used to sort the returned traces.
/// Can be one of the following:
///
/// * `trace_id`
/// * `name` (`name` field of root span in the trace)
/// * `duration` (difference between `end_time` and `start_time` fields of
/// the root span)
/// * `start` (`start_time` field of the root span)
///
/// Descending order can be specified by appending `desc` to the sort field
/// (for example, `name desc`).
///
/// Only one sort field is permitted.
#[prost(string, tag = "8")]
pub order_by: ::prost::alloc::string::String,
}
/// Nested message and enum types in `ListTracesRequest`.
pub mod list_traces_request {
/// Type of data returned for traces in the list.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ViewType {
/// Default is `MINIMAL` if unspecified.
Unspecified = 0,
/// Minimal view of the trace record that contains only the project
/// and trace IDs.
Minimal = 1,
/// Root span view of the trace record that returns the root spans along
/// with the minimal trace data.
Rootspan = 2,
/// Complete view of the trace record that contains the actual trace data.
/// This is equivalent to calling the REST `get` or RPC `GetTrace` method
/// using the ID of each listed trace.
Complete = 3,
}
impl ViewType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ViewType::Unspecified => "VIEW_TYPE_UNSPECIFIED",
ViewType::Minimal => "MINIMAL",
ViewType::Rootspan => "ROOTSPAN",
ViewType::Complete => "COMPLETE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"VIEW_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"MINIMAL" => Some(Self::Minimal),
"ROOTSPAN" => Some(Self::Rootspan),
"COMPLETE" => Some(Self::Complete),
_ => None,
}
}
}
}
/// The response message for the `ListTraces` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTracesResponse {
/// List of trace records as specified by the view parameter.
#[prost(message, repeated, tag = "1")]
pub traces: ::prost::alloc::vec::Vec<Trace>,
/// If defined, indicates that there are more traces that match the request
/// and that this value should be passed to the next request to continue
/// retrieving additional traces.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// The request message for the `GetTrace` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTraceRequest {
/// Required. ID of the Cloud project where the trace data is stored.
#[prost(string, tag = "1")]
pub project_id: ::prost::alloc::string::String,
/// Required. ID of the trace to return.
#[prost(string, tag = "2")]
pub trace_id: ::prost::alloc::string::String,
}
/// The request message for the `PatchTraces` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PatchTracesRequest {
/// Required. ID of the Cloud project where the trace data is stored.
#[prost(string, tag = "1")]
pub project_id: ::prost::alloc::string::String,
/// Required. The body of the message.
#[prost(message, optional, tag = "2")]
pub traces: ::core::option::Option<Traces>,
}
/// Generated client implementations.
pub mod trace_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// This file describes an API for collecting and viewing traces and spans
/// within a trace. A Trace is a collection of spans corresponding to a single
/// operation or set of operations for an application. A span is an individual
/// timed event which forms a node of the trace tree. Spans for a single trace
/// may span multiple services.
#[derive(Debug, Clone)]
pub struct TraceServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> TraceServiceClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> TraceServiceClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
>>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
{
TraceServiceClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Returns of a list of traces that match the specified filter conditions.
pub async fn list_traces(
&mut self,
request: impl tonic::IntoRequest<super::ListTracesRequest>,
) -> std::result::Result<
tonic::Response<super::ListTracesResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.devtools.cloudtrace.v1.TraceService/ListTraces",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.devtools.cloudtrace.v1.TraceService",
"ListTraces",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a single trace by its ID.
pub async fn get_trace(
&mut self,
request: impl tonic::IntoRequest<super::GetTraceRequest>,
) -> std::result::Result<tonic::Response<super::Trace>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.devtools.cloudtrace.v1.TraceService/GetTrace",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.devtools.cloudtrace.v1.TraceService",
"GetTrace",
),
);
self.inner.unary(req, path, codec).await
}
/// Sends new traces to Stackdriver Trace or updates existing traces. If the ID
/// of a trace that you send matches that of an existing trace, any fields
/// in the existing trace and its spans are overwritten by the provided values,
/// and any new fields provided are merged with the existing trace data. If the
/// ID does not match, a new trace is created.
pub async fn patch_traces(
&mut self,
request: impl tonic::IntoRequest<super::PatchTracesRequest>,
) -> std::result::Result<tonic::Response<()>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.devtools.cloudtrace.v1.TraceService/PatchTraces",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.devtools.cloudtrace.v1.TraceService",
"PatchTraces",
),
);
self.inner.unary(req, path, codec).await
}
}
}