Blame - docs/dyn/cloudtrace_v2.projects.traces.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

76

<h2>Instance Methods</h2>

77

78

<code><a href="cloudtrace_v2.projects.traces.spans.html">spans()</a></code>

79

</p>

80

<p class="firstline">Returns the spans Resource.</p>

81

82

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

83

<code><a href="#batchWrite">batchWrite(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

84

<p class="firstline">Sends new spans to new or existing traces. You cannot update</p>

85

<h3>Method Details</h3>

86

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

87

<code class="details" id="batchWrite">batchWrite(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<pre>Sends new spans to new or existing traces. You cannot update

existing spans.

Args:

name: string, Required. The name of the project where the spans belong. The format is

93

`projects/[PROJECT_ID]`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

94

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

95

The object takes the form of:

96

97

{ # The request message for the `BatchWriteSpans` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

98

"spans": [ # Required. A list of new spans. The span names must not match existing

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

99

# spans, or the results are undefined.

100

{ # A span represents a single operation within a trace. Spans can be

101

# nested to form a trace tree. Often, a trace contains a root span

102

# that describes the end-to-end latency, and one or more subspans for

103

# its sub-operations. A trace can also contain multiple root spans,

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

104

# or none at all. Spans do not need to be contiguous&mdash;there may be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

105

# gaps or overlaps between spans in a trace.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

106

"displayName": { # Represents a string that might be shortened to a specified length. # Required. A description of the span's operation (up to 128 bytes).

107

# Trace displays the description in the

108

# Google Cloud Platform Console.

109

# For example, the display name can be a qualified method name or a file name

110

# and a line number where the operation is called. A best practice is to use

111

# the same display name within an application and at the same call point.

112

# This makes it easier to correlate spans in different traces.

113

"value": "A String", # The shortened string. For example, if the original string is 500

114

# bytes long and the limit of the string is 128 bytes, then

115

# `value` contains the first 128 bytes of the 500-byte string.

116

#

117

# Truncation always happens on a UTF8 character boundary. If there

118

# are multi-byte characters in the string, then the length of the

119

# shortened string might be less than the size limit.

120

"truncatedByteCount": 42, # The number of bytes removed from the original string. If this

121

# value is 0, then the string was not shortened.

122

},

123

"links": { # A collection of links, which are references from this span to a span # Links associated with the span. You can have up to 128 links per Span.

124

# in the same or different trace.

125

"link": [ # A collection of links.

126

{ # A pointer from the current span to another span in the same trace or in a

127

# different trace. For example, this can be used in batching operations,

128

# where a single batch handler processes multiple requests from different

129

# traces or when the handler receives a request from a different project.

130

"traceId": "A String", # The [TRACE_ID] for a trace within a project.

131

"type": "A String", # The relationship of the current span relative to the linked span.

132

"spanId": "A String", # The [SPAN_ID] for a span within a trace.

133

"attributes": { # A set of attributes, each in the format `[KEY]:[VALUE]`. # A set of attributes on the link. You have have up to 32 attributes per

134

# link.

135

"attributeMap": { # The set of attributes. Each attribute's key can be up to 128 bytes

136

# long. The value can be a string up to 256 bytes, a signed 64-bit integer,

137

# or the Boolean values `true` and `false`. For example:

138

#

139

# "/instance_id": { "string_value": { "value": "my-instance" } }

140

# "/http/request_bytes": { "int_value": 300 }

141

# "abc.com/myattribute": { "bool_value": false }

142

"a_key": { # The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.

143

"stringValue": { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long.

144

"value": "A String", # The shortened string. For example, if the original string is 500

145

# bytes long and the limit of the string is 128 bytes, then

146

# `value` contains the first 128 bytes of the 500-byte string.

147

#

148

# Truncation always happens on a UTF8 character boundary. If there

149

# are multi-byte characters in the string, then the length of the

150

# shortened string might be less than the size limit.

151

"truncatedByteCount": 42, # The number of bytes removed from the original string. If this

152

# value is 0, then the string was not shortened.

153

},

154

"intValue": "A String", # A 64-bit signed integer.

155

"boolValue": True or False, # A Boolean value represented by `true` or `false`.

156

},

157

},

158

"droppedAttributesCount": 42, # The number of attributes that were discarded. Attributes can be discarded

159

# because their keys are too long or because there are too many attributes.

160

# If this value is 0 then all attributes are valid.

},

},

],

"droppedLinksCount": 42, # The number of dropped links after the maximum size was enforced. If

165

# this value is 0, then no links were dropped.

166

},

167

"parentSpanId": "A String", # The [SPAN_ID] of this span's parent span. If this is a root span,

168

# then this field must be empty.

169

"timeEvents": { # A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation # A set of time events. You can have up to 32 annotations and 128 message

170

# events per span.

171

# on the span, consisting of either user-supplied key:value pairs, or

172

# details of a message sent/received between Spans.

173

"droppedMessageEventsCount": 42, # The number of dropped message events in all the included time events.

174

# If the value is 0, then no message events were dropped.

175

"timeEvent": [ # A collection of `TimeEvent`s.

176

{ # A time-stamped annotation or message event in the Span.

177

"time": "A String", # The timestamp indicating the time the event occurred.

178

"annotation": { # Text annotation with a set of attributes. # Text annotation with a set of attributes.

179

"description": { # Represents a string that might be shortened to a specified length. # A user-supplied message describing the event. The maximum length for

180

# the description is 256 bytes.

181

"value": "A String", # The shortened string. For example, if the original string is 500

182

# bytes long and the limit of the string is 128 bytes, then

183

# `value` contains the first 128 bytes of the 500-byte string.

184

#

185

# Truncation always happens on a UTF8 character boundary. If there

186

# are multi-byte characters in the string, then the length of the

187

# shortened string might be less than the size limit.

188

"truncatedByteCount": 42, # The number of bytes removed from the original string. If this

189

# value is 0, then the string was not shortened.

190

},

191

"attributes": { # A set of attributes, each in the format `[KEY]:[VALUE]`. # A set of attributes on the annotation. You can have up to 4 attributes

192

# per Annotation.

193

"attributeMap": { # The set of attributes. Each attribute's key can be up to 128 bytes

194

# long. The value can be a string up to 256 bytes, a signed 64-bit integer,

195

# or the Boolean values `true` and `false`. For example:

196

#

197

# "/instance_id": { "string_value": { "value": "my-instance" } }

198

# "/http/request_bytes": { "int_value": 300 }

199

# "abc.com/myattribute": { "bool_value": false }

200

"a_key": { # The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.

201

"stringValue": { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long.

202

"value": "A String", # The shortened string. For example, if the original string is 500

203

# bytes long and the limit of the string is 128 bytes, then

204

# `value` contains the first 128 bytes of the 500-byte string.

205

#

206

# Truncation always happens on a UTF8 character boundary. If there

207

# are multi-byte characters in the string, then the length of the

208

# shortened string might be less than the size limit.

209

"truncatedByteCount": 42, # The number of bytes removed from the original string. If this

210

# value is 0, then the string was not shortened.

211

},

212

"intValue": "A String", # A 64-bit signed integer.

213

"boolValue": True or False, # A Boolean value represented by `true` or `false`.

214

},

215

},

216

"droppedAttributesCount": 42, # The number of attributes that were discarded. Attributes can be discarded

217

# because their keys are too long or because there are too many attributes.

218

# If this value is 0 then all attributes are valid.

219

},

220

},

221

"messageEvent": { # An event describing a message sent/received between Spans. # An event describing a message sent/received between Spans.

222

"compressedSizeBytes": "A String", # The number of compressed bytes sent or received. If missing assumed to

223

# be the same size as uncompressed.

224

"uncompressedSizeBytes": "A String", # The number of uncompressed bytes sent or received.

225

"id": "A String", # An identifier for the MessageEvent's message that can be used to match

226

# SENT and RECEIVED MessageEvents. It is recommended to be unique within

227

# a Span.

228

"type": "A String", # Type of MessageEvent. Indicates whether the message was sent or

# received.

},

},

],

"droppedAnnotationsCount": 42, # The number of dropped annotations in all the included time events.

234

# If the value is 0, then no annotations were dropped.

235

},

236

"name": "A String", # Required. The resource name of the span in the following format:

237

#

238

# projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;

239

# it is a 32-character hexadecimal encoding of a 16-byte array.

240

#

241

# [SPAN_ID] is a unique identifier for a span within a trace; it

242

# is a 16-character hexadecimal encoding of an 8-byte array. It should not

243

# be zero.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

244

"status": { # The `Status` type defines a logical error model that is suitable for # Optional. The final status for this span.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

245

# different programming environments, including REST APIs and RPC APIs. It is

246

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

247

# three pieces of data: error code, error message, and error details.

248

#

249

# You can find out more about this error model and how to work with it in the

250

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

251

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

252

# message types for APIs to use.

253

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

254

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

255

},

256

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

257

"message": "A String", # A developer-facing error message, which should be in English. Any

258

# user-facing error message should be localized and sent in the

259

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

260

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

261

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

262

"childSpanCount": 42, # Optional. The number of child spans that were generated while this span

263

# was active. If set, allows implementation to detect missing child spans.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

264

"stackTrace": { # A call stack appearing in a trace. # Stack trace captured at the start of the span.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

265

"stackTraceHashId": "A String", # The hash ID is used to conserve network bandwidth for duplicate

266

# stack traces within a single trace.

267

#

268

# Often multiple spans will have identical stack traces.

269

# The first occurrence of a stack trace should contain both the

270

# `stackFrame` content and a value in `stackTraceHashId`.

271

#

272

# Subsequent spans within the same request can refer

273

# to that stack trace by only setting `stackTraceHashId`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

274

"stackFrames": { # A collection of stack frames, which can be truncated. # Stack frames in this stack trace. A maximum of 128 frames are allowed.

275

"droppedFramesCount": 42, # The number of stack frames that were dropped because there

276

# were too many stack frames.

277

# If this value is 0, then no stack frames were dropped.

278

"frame": [ # Stack frames in this call stack.

279

{ # Represents a single stack frame in a stack trace.

280

"lineNumber": "A String", # The line number in `file_name` where the function call appears.

281

"functionName": { # Represents a string that might be shortened to a specified length. # The fully-qualified name that uniquely identifies the function or

282

# method that is active in this frame (up to 1024 bytes).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

283

"value": "A String", # The shortened string. For example, if the original string is 500

284

# bytes long and the limit of the string is 128 bytes, then

285

# `value` contains the first 128 bytes of the 500-byte string.

286

#

287

# Truncation always happens on a UTF8 character boundary. If there

288

# are multi-byte characters in the string, then the length of the

289

# shortened string might be less than the size limit.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

290

"truncatedByteCount": 42, # The number of bytes removed from the original string. If this

291

# value is 0, then the string was not shortened.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

292

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

293

"sourceVersion": { # Represents a string that might be shortened to a specified length. # The version of the deployed source code (up to 128 bytes).

294

"value": "A String", # The shortened string. For example, if the original string is 500

295

# bytes long and the limit of the string is 128 bytes, then

296

# `value` contains the first 128 bytes of the 500-byte string.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

297

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

298

# Truncation always happens on a UTF8 character boundary. If there

299

# are multi-byte characters in the string, then the length of the

300

# shortened string might be less than the size limit.

301

"truncatedByteCount": 42, # The number of bytes removed from the original string. If this

302

# value is 0, then the string was not shortened.

303

},

304

"loadModule": { # Binary module. # The binary module from where the code was loaded.

305

"buildId": { # Represents a string that might be shortened to a specified length. # A unique identifier for the module, usually a hash of its

306

# contents (up to 128 bytes).

307

"value": "A String", # The shortened string. For example, if the original string is 500

308

# bytes long and the limit of the string is 128 bytes, then

309

# `value` contains the first 128 bytes of the 500-byte string.

310

#

311

# Truncation always happens on a UTF8 character boundary. If there

312

# are multi-byte characters in the string, then the length of the

313

# shortened string might be less than the size limit.

314

"truncatedByteCount": 42, # The number of bytes removed from the original string. If this

315

# value is 0, then the string was not shortened.

316

},

317

"module": { # Represents a string that might be shortened to a specified length. # For example: main binary, kernel modules, and dynamic libraries

318

# such as libc.so, sharedlib.so (up to 256 bytes).

319

"value": "A String", # The shortened string. For example, if the original string is 500

320

# bytes long and the limit of the string is 128 bytes, then

321

# `value` contains the first 128 bytes of the 500-byte string.

322

#

323

# Truncation always happens on a UTF8 character boundary. If there

324

# are multi-byte characters in the string, then the length of the

325

# shortened string might be less than the size limit.

326

"truncatedByteCount": 42, # The number of bytes removed from the original string. If this

327

# value is 0, then the string was not shortened.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

328

},

329

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

330

"columnNumber": "A String", # The column number where the function call appears, if available.

331

# This is important in JavaScript because of its anonymous functions.

332

"originalFunctionName": { # Represents a string that might be shortened to a specified length. # An un-mangled function name, if `function_name` is

333

# [mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can

334

# be fully-qualified (up to 1024 bytes).

335

"value": "A String", # The shortened string. For example, if the original string is 500

336

# bytes long and the limit of the string is 128 bytes, then

337

# `value` contains the first 128 bytes of the 500-byte string.

338

#

339

# Truncation always happens on a UTF8 character boundary. If there

340

# are multi-byte characters in the string, then the length of the

341

# shortened string might be less than the size limit.

342

"truncatedByteCount": 42, # The number of bytes removed from the original string. If this

343

# value is 0, then the string was not shortened.

344

},

345

"fileName": { # Represents a string that might be shortened to a specified length. # The name of the source file where the function call appears (up to 256

346

# bytes).

347

"value": "A String", # The shortened string. For example, if the original string is 500

348

# bytes long and the limit of the string is 128 bytes, then

349

# `value` contains the first 128 bytes of the 500-byte string.

350

#

351

# Truncation always happens on a UTF8 character boundary. If there

352

# are multi-byte characters in the string, then the length of the

353

# shortened string might be less than the size limit.

354

"truncatedByteCount": 42, # The number of bytes removed from the original string. If this

355

# value is 0, then the string was not shortened.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

356

},

357

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

358

],

359

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

360

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

361

"attributes": { # A set of attributes, each in the format `[KEY]:[VALUE]`. # A set of attributes on the span. You can have up to 32 attributes per

362

# span.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

363

"attributeMap": { # The set of attributes. Each attribute's key can be up to 128 bytes

364

# long. The value can be a string up to 256 bytes, a signed 64-bit integer,

365

# or the Boolean values `true` and `false`. For example:

366

#

367

# "/instance_id": { "string_value": { "value": "my-instance" } }

368

# "/http/request_bytes": { "int_value": 300 }

369

# "abc.com/myattribute": { "bool_value": false }

370

"a_key": { # The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

371

"stringValue": { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

372

"value": "A String", # The shortened string. For example, if the original string is 500

373

# bytes long and the limit of the string is 128 bytes, then

374

# `value` contains the first 128 bytes of the 500-byte string.

375

#

376

# Truncation always happens on a UTF8 character boundary. If there

377

# are multi-byte characters in the string, then the length of the

378

# shortened string might be less than the size limit.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

379

"truncatedByteCount": 42, # The number of bytes removed from the original string. If this

380

# value is 0, then the string was not shortened.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

381

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

382

"intValue": "A String", # A 64-bit signed integer.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

383

"boolValue": True or False, # A Boolean value represented by `true` or `false`.

384

},

385

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

386

"droppedAttributesCount": 42, # The number of attributes that were discarded. Attributes can be discarded

387

# because their keys are too long or because there are too many attributes.

388

# If this value is 0 then all attributes are valid.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

389

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

390

"spanKind": "A String", # Optional. Distinguishes between spans generated in a particular context. For example,

391

# two spans with the same name may be distinguished using `CLIENT` (caller)

392

# and `SERVER` (callee) to identify an RPC call.

393

"endTime": "A String", # Required. The end time of the span. On the client side, this is the time kept by

394

# the local machine where the span execution ends. On the server side, this

395

# is the time when the server application handler stops running.

396

"startTime": "A String", # Required. The start time of the span. On the client side, this is the time kept by

397

# the local machine where the span execution starts. On the server side, this

398

# is the time when the server's application handler starts running.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

399

"spanId": "A String", # Required. The [SPAN_ID] portion of the span's resource name.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

400

"sameProcessAsParentSpan": True or False, # Optional. Set this parameter to indicate whether this span is in

401

# the same process as its parent. If you do not set this parameter,

402

# Trace is unable to take advantage of this helpful information.

Bu Sun Kim