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

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dan O'Meara

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

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

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

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

[diff] [blame]

83

<pre>Creates a new span.

Dan O'Meara

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

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

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

[diff] [blame]

95

body: object, The request body.

Bu Sun Kim

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

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

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

[diff] [blame]

103

# gaps or overlaps between spans in a trace.

Bu Sun Kim

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

[diff] [blame]

104

"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

105

# span.

106

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

107

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

108

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

109

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

110

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

111

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

112

#

113

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

114

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

115

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

116

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

117

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

118

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

119

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

120

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

121

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

122

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

123

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

124

#

125

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

126

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

127

# shortened string might be less than the size limit.

128

},

129

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

},

},

},

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

134

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

135

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

136

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

137

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

138

# Stackdriver Trace is unable to take advantage of this helpful

139

# information.

140

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

141

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

142

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

143

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

144

#

145

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

146

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

Bu Sun Kim

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

[diff] [blame]

147

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

148

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

Bu Sun Kim

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

[diff] [blame]

149

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

150

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

Bu Sun Kim

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

[diff] [blame]

151

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

152

# message types for APIs to use.

153

{

Bu Sun Kim

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

[diff] [blame]

154

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

Bu Sun Kim

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

[diff] [blame]

155

},

156

],

157

},

Bu Sun Kim

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

[diff] [blame]

158

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

Dan O'Meara

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

[diff] [blame]

159

#

160

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

161

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

162

#

163

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

164

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

Bu Sun Kim

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

[diff] [blame]

165

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

166

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

Bu Sun Kim

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

[diff] [blame]

167

# stack traces within a single trace.

168

#

169

# Often multiple spans will have identical stack traces.

170

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

171

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

172

#

173

# Subsequent spans within the same request can refer

174

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

Bu Sun Kim

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

[diff] [blame]

175

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

176

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

177

# were too many stack frames.

178

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

179

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

Bu Sun Kim

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

[diff] [blame]

180

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

Bu Sun Kim

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

[diff] [blame]

181

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

182

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

183

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

Bu Sun Kim

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

[diff] [blame]

184

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

Bu Sun Kim

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

[diff] [blame]

185

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

186

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

187

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

Bu Sun Kim

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

[diff] [blame]

188

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

189

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

190

#

191

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

192

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

193

# shortened string might be less than the size limit.

Bu Sun Kim

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

[diff] [blame]

194

},

195

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

196

# contents (up to 128 bytes).

197

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

Bu Sun Kim

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

[diff] [blame]

198

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

Bu Sun Kim

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

[diff] [blame]

199

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

200

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

201

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

202

#

203

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

204

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

205

# shortened string might be less than the size limit.

Bu Sun Kim

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

[diff] [blame]

206

},

207

},

Bu Sun Kim

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

[diff] [blame]

208

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

209

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

210

"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

211

# bytes).

212

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

213

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

214

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

215

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

216

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

217

#

218

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

219

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

220

# shortened string might be less than the size limit.

221

},

222

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

223

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

224

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

225

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

226

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

227

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

228

#

229

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

230

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

231

# shortened string might be less than the size limit.

232

},

233

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

Bu Sun Kim

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

[diff] [blame]

234

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

235

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

Bu Sun Kim

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

[diff] [blame]

236

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

237

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

238

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

Bu Sun Kim

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

[diff] [blame]

239

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

240

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

241

#

242

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

243

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

244

# shortened string might be less than the size limit.

Bu Sun Kim

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

[diff] [blame]

245

},

246

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

247

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

248

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

Bu Sun Kim

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

[diff] [blame]

249

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

Bu Sun Kim

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

[diff] [blame]

250

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

251

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

252

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

253

#

254

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

255

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

256

# shortened string might be less than the size limit.

Bu Sun Kim

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

[diff] [blame]

257

},

258

},

259

],

Bu Sun Kim

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

[diff] [blame]

260

},

261

},

Bu Sun Kim

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

[diff] [blame]

262

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

263

# then this field must be empty.

264

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

265

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

266

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

267

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

Dan O'Meara

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

[diff] [blame]

268

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

269

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

Bu Sun Kim

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

[diff] [blame]

270

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

Bu Sun Kim

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

[diff] [blame]

271

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

Bu Sun Kim

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

[diff] [blame]

272

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

273

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

274

# Stackdriver Trace displays the description in the

275

# Google Cloud Platform Console.

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

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

Bu Sun Kim

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

[diff] [blame]

285

#

Bu Sun Kim

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

[diff] [blame]

286

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

287

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

288

# shortened string might be less than the size limit.

Bu Sun Kim

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

[diff] [blame]

289

},

Bu Sun Kim

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

[diff] [blame]

290

"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

Bu Sun Kim

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

[diff] [blame]

291

# events per span.

292

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

293

# details of a message sent/received between Spans.

Bu Sun Kim

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

[diff] [blame]

294

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

295

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

296

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

297

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

298

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

Bu Sun Kim

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

[diff] [blame]

299

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

Bu Sun Kim

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

[diff] [blame]

300

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

301

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

Bu Sun Kim

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

[diff] [blame]

302

# received.

Bu Sun Kim

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

[diff] [blame]

303

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

Bu Sun Kim

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

[diff] [blame]

304

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

305

# a Span.

Bu Sun Kim

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

[diff] [blame]

306

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

Bu Sun Kim

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

[diff] [blame]

307

# be the same size as uncompressed.

Bu Sun Kim

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

[diff] [blame]

308

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

Bu Sun Kim

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

[diff] [blame]

309

},

Bu Sun Kim

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

[diff] [blame]

310

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

311

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

312

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

313

# the description is 256 bytes.

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

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

317

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

318

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

319

#

320

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

321

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

322

# shortened string might be less than the size limit.

323

},

324

"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

Bu Sun Kim

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

[diff] [blame]

325

# per Annotation.

Bu Sun Kim

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

[diff] [blame]

326

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

Bu Sun Kim

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

[diff] [blame]

327

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

328

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

Bu Sun Kim

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

[diff] [blame]

329

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

Bu Sun Kim

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

[diff] [blame]

330

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

331

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

332

#

Bu Sun Kim

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

[diff] [blame]

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

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

Bu Sun Kim

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

[diff] [blame]

342

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

343

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

344

#

345

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

346

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

347

# shortened string might be less than the size limit.

Bu Sun Kim

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

[diff] [blame]

348

},

Bu Sun Kim

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

[diff] [blame]

349

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

Bu Sun Kim

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

[diff] [blame]

350

},

351

},

352

},

Bu Sun Kim

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

[diff] [blame]

353

},

Bu Sun Kim

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

[diff] [blame]

354

},

355

],

Bu Sun Kim

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

[diff] [blame]

356

},

Bu Sun Kim

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

[diff] [blame]

357

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

358

# in the same or different trace.

359

"link": [ # A collection of links.

360

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

361

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

362

# where a single batch handler processes multiple requests from different

363

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

364

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

365

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

366

"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

367

# link.

368

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

369

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

370

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

371

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

372

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

373

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

374

#

375

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

376

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

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

#

387

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

388

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

389

# shortened string might be less than the size limit.

390

},

391

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

},

},

},

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

396

},

397

],

398

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

399

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

400

},

Bu Sun Kim

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

[diff] [blame]

401

}

402

403

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

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

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

[diff] [blame]

416

# gaps or overlaps between spans in a trace.

Bu Sun Kim

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

[diff] [blame]

417

"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

418

# span.

419

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

420

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

421

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

422

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

423

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

424

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

425

#

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

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

435

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

436

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

437

#

438

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

439

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

440

# shortened string might be less than the size limit.

441

},

442

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

},

},

},

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

447

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

448

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

449

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

450

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

451

# Stackdriver Trace is unable to take advantage of this helpful

452

# information.

453

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

454

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

455

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

456

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

457

#

458

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

459

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

Bu Sun Kim

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

[diff] [blame]

460

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

461

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

Bu Sun Kim

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

[diff] [blame]

462

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

463

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

Bu Sun Kim

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

[diff] [blame]

464

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

465

# message types for APIs to use.

466

{

Bu Sun Kim

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

[diff] [blame]

467

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

Bu Sun Kim

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

[diff] [blame]

468

},

469

],

470

},

Bu Sun Kim

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

[diff] [blame]

471

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

Dan O'Meara

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

[diff] [blame]

472

#

473

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

474

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

475

#

476

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

477

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

Bu Sun Kim

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

[diff] [blame]

478

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

479

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

Bu Sun Kim

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

[diff] [blame]

480

# stack traces within a single trace.

481

#

482

# Often multiple spans will have identical stack traces.

483

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

484

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

485

#

486

# Subsequent spans within the same request can refer

487

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

Bu Sun Kim

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

[diff] [blame]

488

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

489

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

490

# were too many stack frames.

491

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

492

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

Bu Sun Kim

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

[diff] [blame]

493

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

Bu Sun Kim

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

[diff] [blame]

494

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

495

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

496

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

Bu Sun Kim

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

[diff] [blame]

497

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

Bu Sun Kim

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

[diff] [blame]

498

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

499

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

500

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

Bu Sun Kim

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

[diff] [blame]

501

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

502

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

503

#

504

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

505

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

506

# shortened string might be less than the size limit.

Bu Sun Kim

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

[diff] [blame]

507

},

508

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

509

# contents (up to 128 bytes).

510

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

Bu Sun Kim

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

[diff] [blame]

511

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

Bu Sun Kim

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

[diff] [blame]

512

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

513

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

514

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

515

#

516

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

517

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

518

# shortened string might be less than the size limit.

Bu Sun Kim

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

[diff] [blame]

519

},

520

},

Bu Sun Kim

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

[diff] [blame]

521

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

522

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

523

"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

524

# bytes).

525

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

526

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

527

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

528

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

529

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

530

#

531

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

532

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

533

# shortened string might be less than the size limit.

534

},

535

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

536

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

537

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

538

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

539

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

540

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

541

#

542

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

543

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

544

# shortened string might be less than the size limit.

545

},

546

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

Bu Sun Kim

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

[diff] [blame]

547

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

548

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

Bu Sun Kim

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

[diff] [blame]

549

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

550

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

551

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

Bu Sun Kim

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

[diff] [blame]

552

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

553

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

554

#

555

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

556

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

557

# shortened string might be less than the size limit.

Bu Sun Kim

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

[diff] [blame]

558

},

559

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

560

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

561

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

Bu Sun Kim

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

[diff] [blame]

562

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

Bu Sun Kim

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

[diff] [blame]

563

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

564

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

565

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

566

#

567

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

568

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

569

# shortened string might be less than the size limit.

Bu Sun Kim

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

[diff] [blame]

570

},

571

},

572

],

Bu Sun Kim

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

[diff] [blame]

573

},

574

},

Bu Sun Kim

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

[diff] [blame]

575

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

576

# then this field must be empty.

577

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

578

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

579

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

580

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

Dan O'Meara

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

[diff] [blame]

581

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

582

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

Bu Sun Kim

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

[diff] [blame]

583

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

Bu Sun Kim

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

[diff] [blame]

584

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

Bu Sun Kim

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

[diff] [blame]

585

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

586

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

587

# Stackdriver Trace displays the description in the

588

# Google Cloud Platform Console.

589

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

590

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

591

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

592

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

593

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

594

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

595

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

596

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

597

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

Bu Sun Kim

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

[diff] [blame]

598

#

Bu Sun Kim

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

[diff] [blame]

599

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

600

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

601

# shortened string might be less than the size limit.

Bu Sun Kim

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

[diff] [blame]

602

},

Bu Sun Kim

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

[diff] [blame]

603

"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

Bu Sun Kim

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

[diff] [blame]

604

# events per span.

605

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

606

# details of a message sent/received between Spans.

Bu Sun Kim

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

[diff] [blame]

607

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

608

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

609

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

610

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

611

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

Bu Sun Kim

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

[diff] [blame]

612

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

Bu Sun Kim

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

[diff] [blame]

613

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

614

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

Bu Sun Kim

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

[diff] [blame]

615

# received.

Bu Sun Kim

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

[diff] [blame]

616

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

Bu Sun Kim

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

[diff] [blame]

617

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

618

# a Span.

Bu Sun Kim

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

[diff] [blame]

619

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

Bu Sun Kim

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

[diff] [blame]

620

# be the same size as uncompressed.

Bu Sun Kim

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

[diff] [blame]

621

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

Bu Sun Kim

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

[diff] [blame]

622

},

Bu Sun Kim

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

[diff] [blame]

623

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

624

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

625

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

626

# the description is 256 bytes.

627

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

628

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

629

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

630

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

631

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

632

#

633

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

634

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

635

# shortened string might be less than the size limit.

636

},

637

"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

Bu Sun Kim

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

[diff] [blame]

638

# per Annotation.

Bu Sun Kim

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

[diff] [blame]

639

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

Bu Sun Kim

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

[diff] [blame]

640

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

641

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

Bu Sun Kim

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

[diff] [blame]

642

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

Bu Sun Kim

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

[diff] [blame]

643

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

644

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

645

#

Bu Sun Kim

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

[diff] [blame]

646

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

647

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

648

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

649

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

650

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

651

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

652

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

653

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

654

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

Bu Sun Kim

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

[diff] [blame]

655

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

656

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

657

#

658

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

659

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

660

# shortened string might be less than the size limit.

Bu Sun Kim

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

[diff] [blame]

661

},

Bu Sun Kim

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

[diff] [blame]

662

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

Bu Sun Kim

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

[diff] [blame]

663

},

664

},

665

},

Bu Sun Kim

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

[diff] [blame]

666

},

Bu Sun Kim

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

[diff] [blame]

667

},

668

],

Bu Sun Kim

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

[diff] [blame]

669

},

Bu Sun Kim

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

[diff] [blame]

670

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

671

# in the same or different trace.

672

"link": [ # A collection of links.

673

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

674

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

675

# where a single batch handler processes multiple requests from different

676

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

677

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

678

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

679

"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

680

# link.

681

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

682

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

683

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

684

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

685

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

686

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

687

#

688

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

689

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

690

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

691

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

692

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

693

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

694

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

695

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

696

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

697

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

698

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

699

#

700

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

701

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

702

# shortened string might be less than the size limit.

703

},

704

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

},

},

},

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

709

},

710

],

711

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

712

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

713

},

Bu Sun Kim