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

<h1><a href="cloudtrace_v2.html">Cloud Trace API</a> . <a href="cloudtrace_v2.projects.html">projects</a> . <a href="cloudtrace_v2.projects.traces.html">traces</a> . <a href="cloudtrace_v2.projects.traces.spans.html">spans</a></h1>

Bu Sun Kim

715bd7f

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dan O'Meara

dd49464

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

[diff] [blame^]

78

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

79

<p class="firstline">Creates a new span.</p>

80

<h3>Method Details</h3>

81

Dan O'Meara

dd49464

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

[diff] [blame^]

82

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

83

<pre>Creates a new span.

Dan O'Meara

dd49464

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

[diff] [blame^]

84

In this case, writing traces is not considered an active developer

85

method since traces are machine generated.

Bu Sun Kim

715bd7f

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

[diff] [blame]

86

87

Args:

88

name: string, The resource name of the span in the following format:

89

90

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

91

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

92

93

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

94

is a 16-character hexadecimal encoding of an 8-byte array. (required)

Dan O'Meara

dd49464

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

[diff] [blame^]

95

body: object, The request body.

Bu Sun Kim

715bd7f

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

[diff] [blame]

96

The object takes the form of:

97

98

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

99

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

100

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

101

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

Dan O'Meara

dd49464

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

[diff] [blame^]

102

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

103

# gaps or overlaps between spans in a trace.

Dan O'Meara

dd49464

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

[diff] [blame^]

104

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

105

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

106

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

107

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

108

#

109

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

110

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

111

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

112

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

113

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

114

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

115

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

116

# message types for APIs to use.

117

{

118

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

119

},

120

],

121

},

Dan O'Meara

dd49464

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

[diff] [blame^]

122

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

123

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

124

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

125

# Stackdriver Trace displays the description in the

126

# Google Cloud Platform Console.

127

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

128

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

129

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

130

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

131

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

132

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

133

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

134

#

135

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

136

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

137

# shortened string might be less than the size limit.

138

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

139

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

140

},

141

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

142

#

143

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

144

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

145

#

146

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

147

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

148

"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.

149

# in the same or different trace.

150

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

151

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

152

"link": [ # A collection of links.

153

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

154

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

155

# where a single batch handler processes multiple requests from different

156

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

157

"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

158

# link.

159

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

160

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

161

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

162

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

163

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

164

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

165

#

166

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

167

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

168

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

169

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

170

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

171

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

172

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

173

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

174

#

175

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

176

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

177

# shortened string might be less than the size limit.

178

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

179

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

180

},

181

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

182

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

},

},

},

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

187

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

188

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

189

},

190

],

191

},

Bu Sun Kim

715bd7f

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

[diff] [blame]

192

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

193

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

194

# stack traces within a single trace.

195

#

196

# Often multiple spans will have identical stack traces.

197

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

198

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

199

#

200

# Subsequent spans within the same request can refer

201

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

202

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

203

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

204

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

205

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

206

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

207

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

208

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

209

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

210

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

211

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

212

#

213

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

214

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

215

# shortened string might be less than the size limit.

216

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

217

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

218

},

219

"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

220

# bytes).

221

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

222

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

223

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

224

#

225

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

226

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

227

# shortened string might be less than the size limit.

228

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

229

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

230

},

231

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

232

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

233

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

234

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

235

#

236

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

237

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

238

# shortened string might be less than the size limit.

239

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

240

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

241

},

242

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

243

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

244

# contents (up to 128 bytes).

245

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

246

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

247

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

248

#

249

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

250

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

251

# shortened string might be less than the size limit.

252

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

253

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

254

},

255

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

256

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

257

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

258

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

259

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

260

#

261

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

262

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

263

# shortened string might be less than the size limit.

264

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

265

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

266

},

267

},

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

#

276

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

277

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

278

# shortened string might be less than the size limit.

279

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

280

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

},

},

],

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

285

# were too many stack frames.

286

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

287

},

288

},

Dan O'Meara

dd49464

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

[diff] [blame^]

289

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

290

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

291

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

292

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

293

# then this field must be empty.

Dan O'Meara

dd49464

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

[diff] [blame^]

294

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

295

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

296

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

Dan O'Meara

dd49464

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

[diff] [blame^]

297

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

298

"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

299

# span.

300

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

301

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

302

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

303

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

304

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

305

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

306

#

Dan O'Meara

dd49464

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

[diff] [blame^]

307

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

308

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

309

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

310

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

311

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

312

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

313

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

314

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

315

#

316

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

317

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

318

# shortened string might be less than the size limit.

319

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

320

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

321

},

Bu Sun Kim

715bd7f

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

[diff] [blame]

322

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

Dan O'Meara

dd49464

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

[diff] [blame^]

323

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

324

},

325

},

326

},

Bu Sun Kim

715bd7f

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

[diff] [blame]

327

"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

328

# events per span.

329

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

330

# details of a message sent/received between Spans.

Bu Sun Kim

715bd7f

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

[diff] [blame]

331

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

332

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

333

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

334

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

335

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

336

# received.

337

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

338

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

339

# a Span.

340

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

341

# be the same size as uncompressed.

342

},

343

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

344

"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

345

# per Annotation.

346

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

347

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

348

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

349

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

350

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

351

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

352

#

Dan O'Meara

dd49464

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

[diff] [blame^]

353

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

354

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

355

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

356

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

357

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

358

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

359

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

360

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

361

#

362

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

363

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

364

# shortened string might be less than the size limit.

365

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

366

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

367

},

Bu Sun Kim

715bd7f

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

[diff] [blame]

368

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

Dan O'Meara

dd49464

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

[diff] [blame^]

369

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

},

},

},

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

374

# the description is 256 bytes.

375

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

376

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

377

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

378

#

379

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

380

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

381

# shortened string might be less than the size limit.

382

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

383

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

384

},

385

},

386

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

387

},

388

],

Dan O'Meara

dd49464

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

[diff] [blame^]

389

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

390

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

391

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

392

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

393

},

Dan O'Meara

dd49464

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

[diff] [blame^]

394

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

395

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

396

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

Dan O'Meara

dd49464

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

[diff] [blame^]

397

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

398

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

399

# Stackdriver Trace is unable to take advantage of this helpful

# information.

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

410

411

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

412

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

413

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

414

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

Dan O'Meara

dd49464

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

[diff] [blame^]

415

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

416

# gaps or overlaps between spans in a trace.

Dan O'Meara

dd49464

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

[diff] [blame^]

417

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

418

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

419

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

420

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

421

#

422

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

423

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

424

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

425

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

426

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

427

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

428

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

429

# message types for APIs to use.

430

{

431

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

432

},

433

],

434

},

Dan O'Meara

dd49464

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

[diff] [blame^]

435

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

436

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

437

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

438

# Stackdriver Trace displays the description in the

439

# Google Cloud Platform Console.

440

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

441

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

442

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

443

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

444

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

445

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

446

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

447

#

448

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

449

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

450

# shortened string might be less than the size limit.

451

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

452

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

453

},

454

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

455

#

456

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

457

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

458

#

459

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

460

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

461

"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.

462

# in the same or different trace.

463

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

464

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

465

"link": [ # A collection of links.

466

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

467

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

468

# where a single batch handler processes multiple requests from different

469

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

470

"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

471

# link.

472

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

473

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

474

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

475

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

476

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

477

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

478

#

479

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

480

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

481

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

482

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

483

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

484

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

485

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

486

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

487

#

488

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

489

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

490

# shortened string might be less than the size limit.

491

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

492

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

493

},

494

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

495

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

},

},

},

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

500

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

501

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

502

},

503

],

504

},

Bu Sun Kim

715bd7f

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

[diff] [blame]

505

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

506

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

507

# stack traces within a single trace.

508

#

509

# Often multiple spans will have identical stack traces.

510

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

511

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

512

#

513

# Subsequent spans within the same request can refer

514

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

515

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

516

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

517

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

518

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

519

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

520

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

521

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

522

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

523

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

524

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

525

#

526

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

527

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

528

# shortened string might be less than the size limit.

529

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

530

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

531

},

532

"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

533

# bytes).

534

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

535

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

536

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

537

#

538

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

539

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

540

# shortened string might be less than the size limit.

541

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

542

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

543

},

544

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

545

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

546

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

547

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

548

#

549

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

550

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

551

# shortened string might be less than the size limit.

552

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

553

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

554

},

555

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

556

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

557

# contents (up to 128 bytes).

558

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

559

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

560

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

561

#

562

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

563

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

564

# shortened string might be less than the size limit.

565

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

566

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

567

},

568

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

569

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

570

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

571

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

572

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

573

#

574

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

575

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

576

# shortened string might be less than the size limit.

577

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

578

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

579

},

580

},

581

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

582

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

583

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

584

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

585

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

586

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

587

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

588

#

589

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

590

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

591

# shortened string might be less than the size limit.

592

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

593

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

},

},

],

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

598

# were too many stack frames.

599

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

600

},

601

},

Dan O'Meara

dd49464

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

[diff] [blame^]

602

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

603

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

604

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

605

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

606

# then this field must be empty.

Dan O'Meara

dd49464

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

[diff] [blame^]

607

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

608

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

609

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

Dan O'Meara

dd49464

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

[diff] [blame^]

610

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

611

"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

612

# span.

613

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

614

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

615

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

616

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

617

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

618

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

619

#

Dan O'Meara

dd49464

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

[diff] [blame^]

620

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

621

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

622

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

623

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

624

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

625

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

626

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

627

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

628

#

629

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

630

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

631

# shortened string might be less than the size limit.

632

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

633

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

634

},

Bu Sun Kim

715bd7f

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

[diff] [blame]

635

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

Dan O'Meara

dd49464

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

[diff] [blame^]

636

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

637

},

638

},

639

},

Bu Sun Kim

715bd7f

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

[diff] [blame]

640

"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

641

# events per span.

642

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

643

# details of a message sent/received between Spans.

Bu Sun Kim

715bd7f

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

[diff] [blame]

644

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

645

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

646

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

647

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

648

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

649

# received.

650

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

651

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

652

# a Span.

653

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

654

# be the same size as uncompressed.

655

},

656

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

657

"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

658

# per Annotation.

659

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

660

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

661

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

662

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

663

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

664

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

665

#

Dan O'Meara

dd49464

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

[diff] [blame^]

666

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

667

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

668

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

669

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

670

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

671

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

672

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

673

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

674

#

675

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

676

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

677

# shortened string might be less than the size limit.

678

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

679

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

680

},

Bu Sun Kim

715bd7f

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

[diff] [blame]

681

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

Dan O'Meara

dd49464

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

[diff] [blame^]

682

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

},

},

},

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

687

# the description is 256 bytes.

688

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

689

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

690

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

691

#

692

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