Home | History | Annotate | Download | only in dyn
      1 <html><body>
      2 <style>
      3 
      4 body, h1, h2, h3, div, span, p, pre, a {
      5   margin: 0;
      6   padding: 0;
      7   border: 0;
      8   font-weight: inherit;
      9   font-style: inherit;
     10   font-size: 100%;
     11   font-family: inherit;
     12   vertical-align: baseline;
     13 }
     14 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, h2, h3 {
     50   border-bottom: solid #CCC 1px;
     51 }
     52 
     53 .toc_element {
     54   margin-top: 0.5em;
     55 }
     56 
     57 .firstline {
     58   margin-left: 2 em;
     59 }
     60 
     61 .method  {
     62   margin-top: 1em;
     63   border: solid 1px #CCC;
     64   padding: 1em;
     65   background: #EEE;
     66 }
     67 
     68 .details {
     69   font-weight: bold;
     70   font-size: 14px;
     71 }
     72 
     73 </style>
     74 
     75 <h1><a href="cloudtrace_v1.html">Stackdriver Trace API</a> . <a href="cloudtrace_v1.projects.html">projects</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="cloudtrace_v1.projects.traces.html">traces()</a></code>
     79 </p>
     80 <p class="firstline">Returns the traces Resource.</p>
     81 
     82 <p class="toc_element">
     83   <code><a href="#patchTraces">patchTraces(projectId, body, x__xgafv=None)</a></code></p>
     84 <p class="firstline">Sends new traces to Stackdriver Trace or updates existing traces. If the ID</p>
     85 <h3>Method Details</h3>
     86 <div class="method">
     87     <code class="details" id="patchTraces">patchTraces(projectId, body, x__xgafv=None)</code>
     88   <pre>Sends new traces to Stackdriver Trace or updates existing traces. If the ID
     89 of a trace that you send matches that of an existing trace, any fields
     90 in the existing trace and its spans are overwritten by the provided values,
     91 and any new fields provided are merged with the existing trace data. If the
     92 ID does not match, a new trace is created.
     93 
     94 Args:
     95   projectId: string, ID of the Cloud project where the trace data is stored. (required)
     96   body: object, The request body. (required)
     97     The object takes the form of:
     98 
     99 { # List of new or updated traces.
    100     "traces": [ # List of traces.
    101       { # A trace describes how long it takes for an application to perform an
    102           # operation. It consists of a set of spans, each of which represent a single
    103           # timed event within the operation.
    104         "projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
    105         "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit
    106             # numeric value formatted as a 32-byte hex string.
    107         "spans": [ # Collection of spans in the trace.
    108           { # A span represents a single timed event within a trace. Spans can be nested
    109               # and form a trace tree. Often, a trace contains a root span that describes the
    110               # end-to-end latency of an operation and, optionally, one or more subspans for
    111               # its suboperations. Spans do not need to be contiguous. There may be gaps
    112               # between spans in a trace.
    113             "kind": "A String", # Distinguishes between spans generated in a particular context. For example,
    114                 # two spans with the same name may be distinguished using `RPC_CLIENT`
    115                 # and `RPC_SERVER` to identify queueing latency associated with the span.
    116             "name": "A String", # Name of the span. Must be less than 128 bytes. The span name is sanitized
    117                 # and displayed in the Stackdriver Trace tool in the
    118                 # {% dynamic print site_values.console_name %}.
    119                 # The name may be a method name or some other per-call site name.
    120                 # For the same executable and the same call point, a best practice is
    121                 # to use a consistent name, which makes it easier to correlate
    122                 # cross-trace spans.
    123             "labels": { # Collection of labels associated with the span. Label keys must be less than
    124                 # 128 bytes. Label values must be less than 16 kilobytes (10MB for
    125                 # `/stacktrace` values).
    126                 #
    127                 # Some predefined label keys exist, or you may create your own. When creating
    128                 # your own, we recommend the following formats:
    129                 #
    130                 # * `/category/product/key` for agents of well-known products (e.g.
    131                 #   `/db/mongodb/read_size`).
    132                 # * `short_host/path/key` for domain-specific keys (e.g.
    133                 #   `foo.com/myproduct/bar`)
    134                 #
    135                 # Predefined labels include:
    136                 #
    137                 # *   `/agent`
    138                 # *   `/component`
    139                 # *   `/error/message`
    140                 # *   `/error/name`
    141                 # *   `/http/client_city`
    142                 # *   `/http/client_country`
    143                 # *   `/http/client_protocol`
    144                 # *   `/http/client_region`
    145                 # *   `/http/host`
    146                 # *   `/http/method`
    147                 # *   `/http/redirected_url`
    148                 # *   `/http/request/size`
    149                 # *   `/http/response/size`
    150                 # *   `/http/status_code`
    151                 # *   `/http/url`
    152                 # *   `/http/user_agent`
    153                 # *   `/pid`
    154                 # *   `/stacktrace`
    155                 # *   `/tid`
    156               "a_key": "A String",
    157             },
    158             "parentSpanId": "A String", # ID of the parent span, if any. Optional.
    159             "startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
    160             "spanId": "A String", # Identifier for the span. Must be a 64-bit integer other than 0 and
    161                 # unique within a trace.
    162             "endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
    163           },
    164         ],
    165       },
    166     ],
    167   }
    168 
    169   x__xgafv: string, V1 error format.
    170     Allowed values
    171       1 - v1 error format
    172       2 - v2 error format
    173 
    174 Returns:
    175   An object of the form:
    176 
    177     { # A generic empty message that you can re-use to avoid defining duplicated
    178       # empty messages in your APIs. A typical example is to use it as the request
    179       # or the response type of an API method. For instance:
    180       #
    181       #     service Foo {
    182       #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
    183       #     }
    184       #
    185       # The JSON representation for `Empty` is empty JSON object `{}`.
    186   }</pre>
    187 </div>
    188 
    189 </body></html>