forked from triton-inference-server/server
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tracer.h
527 lines (460 loc) · 21.4 KB
/
tracer.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
// Copyright 2019-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of NVIDIA CORPORATION nor the names of its
// contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#pragma once
#include <atomic>
#include <condition_variable>
#include <fstream>
#include <memory>
#include <mutex>
#include <set>
#include <sstream>
#include <stack>
#include <string>
#include <unordered_map>
#include <variant>
#if !defined(_WIN32) && defined(TRITON_ENABLE_TRACING)
#include "opentelemetry/context/propagation/global_propagator.h"
#include "opentelemetry/exporters/otlp/otlp_http_exporter_factory.h"
#include "opentelemetry/nostd/shared_ptr.h"
#include "opentelemetry/sdk/resource/resource.h"
#include "opentelemetry/sdk/trace/batch_span_processor_options.h"
#include "opentelemetry/sdk/trace/processor.h"
#include "opentelemetry/sdk/trace/tracer_provider_factory.h"
#include "opentelemetry/trace/context.h"
#include "opentelemetry/trace/propagation/http_trace_context.h"
#include "opentelemetry/trace/provider.h"
namespace otlp = opentelemetry::exporter::otlp;
namespace otel_trace_sdk = opentelemetry::sdk::trace;
namespace otel_trace_api = opentelemetry::trace;
namespace otel_cntxt = opentelemetry::context;
namespace otel_resource = opentelemetry::sdk::resource;
#endif
#include "triton/core/tritonserver.h"
#define TRITONJSON_STATUSTYPE TRITONSERVER_Error*
#define TRITONJSON_STATUSSUCCESS nullptr
#define TRITONJSON_STATUSRETURN(M) \
return TRITONSERVER_ErrorNew(TRITONSERVER_ERROR_INTERNAL, (M).c_str())
#include "triton/common/triton_json.h"
namespace triton { namespace server {
using TraceConfig = std::vector<
std::pair<std::string, std::variant<std::string, int, uint32_t>>>;
// Key is trace mode,
using TraceConfigMap = std::unordered_map<std::string, TraceConfig>;
#if !defined(_WIN32) && defined(TRITON_ENABLE_TRACING)
using AbstractCarrier = otel_cntxt::propagation::TextMapCarrier;
#else
using AbstractCarrier = void*;
#endif
// Common OTel span keys to store in OTel context
// with the corresponding trace id.
constexpr char kRootSpan[] = "root_span";
constexpr char kRequestSpan[] = "request_span";
constexpr char kComputeSpan[] = "compute_span";
// OTel tracer name
constexpr char kTritonTracer[] = "triton-server";
/// Trace modes.
typedef enum tracemode_enum {
/// Default is Triton tracing API
TRACE_MODE_TRITON = 0,
/// OpenTelemetry API for tracing
TRACE_MODE_OPENTELEMETRY = 1
} InferenceTraceMode;
//
// Manager for tracing to a file.
//
class TraceManager {
private:
class TraceSetting;
public:
static constexpr int32_t MIN_TRACE_COUNT_VALUE{-1};
// The new field values for a setting, 'clear_xxx_' indicates
// whether to clear the previously specified filed value.
// If false, 'xxx_' will be used as the new field value.
// If 'xxx_' is nullptr, the field value will not be updated.
struct NewSetting {
NewSetting()
: clear_level_(false), level_(nullptr), clear_rate_(false),
rate_(nullptr), clear_count_(false), count_(nullptr),
clear_log_frequency_(false), log_frequency_(nullptr), mode_(nullptr),
config_map_(nullptr)
{
}
bool clear_level_;
const TRITONSERVER_InferenceTraceLevel* level_;
bool clear_rate_;
const uint32_t* rate_;
bool clear_count_;
const int32_t* count_;
bool clear_log_frequency_;
const uint32_t* log_frequency_;
const InferenceTraceMode* mode_;
const TraceConfigMap* config_map_;
};
struct Trace;
// Create a trace manager that appends trace information
// to a specified file as global setting.
static TRITONSERVER_Error* Create(
TraceManager** manager, const TRITONSERVER_InferenceTraceLevel level,
const uint32_t rate, const int32_t count, const uint32_t log_frequency,
const std::string& filepath, const InferenceTraceMode mode,
const TraceConfigMap& config_map);
~TraceManager() { CleanupTracer(); }
/// Options required at Trace initialization
struct TraceStartOptions {
#if !defined(_WIN32) && defined(TRITON_ENABLE_TRACING)
otel_cntxt::Context propagated_context{otel_cntxt::Context{}};
#else
void* propagated_context{nullptr};
#endif
std::shared_ptr<TraceSetting> trace_setting{nullptr};
bool force_sample{false};
};
// Returns TraceStartOptions for specified model
TraceStartOptions GetTraceStartOptions(
AbstractCarrier& carriers, const std::string& model_name);
// Return a trace that should be used to collected trace activities
// for an inference request. Return nullptr if no tracing should occur.
std::shared_ptr<Trace> SampleTrace(const TraceStartOptions& start_options);
// Update global setting if 'model_name' is empty, otherwise, model setting is
// updated.
TRITONSERVER_Error* UpdateTraceSetting(
const std::string& model_name, const NewSetting& new_setting);
void GetTraceSetting(
const std::string& model_name, TRITONSERVER_InferenceTraceLevel* level,
uint32_t* rate, int32_t* count, uint32_t* log_frequency,
std::string* filepath, InferenceTraceMode* mode,
TraceConfigMap* config_map);
// Sets provided TraceSetting with correct trace settings for provided model.
void GetTraceSetting(
const std::string& model_name,
std::shared_ptr<TraceSetting>& trace_setting);
// Return the current timestamp.
static uint64_t CaptureTimestamp()
{
return std::chrono::duration_cast<std::chrono::nanoseconds>(
std::chrono::steady_clock::now().time_since_epoch())
.count();
}
static void TraceRelease(TRITONSERVER_InferenceTrace* trace, void* userp);
static const char* InferenceTraceModeString(InferenceTraceMode mode);
/// In OpenTelemetry trace mode initializes Opentelemetry exporter, processor,
/// and sets the global trace provider.
/// In Triton trace mode is a no-op.
///
/// \param config_map A config map, which stores all parameters, specified
/// by user.
void InitTracer(const TraceConfigMap& config_map);
/// In OpenTelemetry trace mode cleans global tracer provider,
/// set by InitTracer.
/// In Triton trace mode is a no-op.
void CleanupTracer();
#if !defined(_WIN32) && defined(TRITON_ENABLE_TRACING)
void ProcessOpenTelemetryParameters(
const triton::server::TraceConfigMap& config_map,
otlp::OtlpHttpExporterOptions& exporter_options,
otel_resource::ResourceAttributes& attributes,
otel_trace_sdk::BatchSpanProcessorOptions& processor_options);
#endif
struct Trace {
Trace() : trace_(nullptr), trace_id_(0) {}
~Trace();
std::shared_ptr<TraceSetting> setting_;
// Group the spawned traces by trace ID for better formatting
std::mutex mtx_;
std::unordered_map<uint64_t, std::unique_ptr<std::stringstream>> streams_;
// We use the set to track the number of spawned traces, so that
// when TraceManager::TraceRelease() with 'trace_userp_' is called
// we can safely release 'trace_userp_'
std::set<uint64_t> spawned_traces_tracker_;
// Triton trace object that this trace is assosicated with,
// 'Trace' object does not take ownership of 'trace_'. The caller of
// SampleTrace() must call TraceManager::TraceRelease() with 'trace_userp_'
// to properly release the resources if 'trace_' is not passed to a
// TRITONSERVER_ServerInferAsync() call.
TRITONSERVER_InferenceTrace* trace_;
void* trace_userp_;
uint64_t trace_id_;
// Capture a timestamp generated outside of triton and associate it
// with this trace.
void CaptureTimestamp(const std::string& name, uint64_t timestamp_ns);
/// Returns activity name. For custom activities, retrieves the name from
/// the trace context. For other activities, returns default name.
///
/// \param trace TRITONSERVER_InferenceTrace instance.
/// \param activity Trace activity.
/// \param timestamp_ns Steady timestamp, which is used to calculate
/// OpenTelemetry SystemTimestamp to display span on a timeline, and
/// OpenTelemetry SteadyTimestamp to calculate the duration on the span
/// with better precision.
std::string RetrieveActivityName(
TRITONSERVER_InferenceTrace* trace,
TRITONSERVER_InferenceTraceActivity activity, uint64_t timestamp_ns);
#if !defined(_WIN32) && defined(TRITON_ENABLE_TRACING)
/// Reports TRITONSERVER_InferenceTraceActivity as event to
/// the currently active span. If activity is an instance of
/// `TRITONSERVER_TRACE_REQUEST_START` or
/// `TRITONSERVER_TRACE_COMPUTE_START`,
/// it starts a new request or compute span. For the request span it
/// adds some triton related attributes, and adds this span to
/// a span stack, corresponding to the current trace. Alternatively,
/// if activity is `TRITONSERVER_TRACE_REQUEST_END` or
/// `TRITONSERVER_TRACE_COMPUTE_END`, it ends the corresponding span.
///
/// \param trace TRITONSERVER_InferenceTrace instance.
/// \param activity Trace activity.
/// \param timestamp_ns Steady timestamp, which is used to calculate
/// OpenTelemetry SystemTimestamp to display span on a timeline, and
/// OpenTelemetry SteadyTimestamp to calculate the duration on the span
/// with better precision.
void ReportToOpenTelemetry(
TRITONSERVER_InferenceTrace* trace,
TRITONSERVER_InferenceTraceActivity activity, uint64_t timestamp_ns);
/// Starts a span with the provided timestamp and name.
///
/// \param display_name Span's name, which will be shown in the trace.
/// \param raw_timestamp_ns Steady timestamp, which is used to calculate
/// OpenTelemetry SystemTimestamp to display span on a timeline, and
/// OpenTelemetry SteadyTimestamp to calculate the duration on the span
/// with better precision.
/// \param trace_id Trace id.
/// \return A shared pointer to a newly created OpenTelemetry span.
opentelemetry::nostd::shared_ptr<otel_trace_api::Span> StartSpan(
std::string display_name, const uint64_t& raw_timestamp_ns,
uint64_t trace_id);
// A map to hold spans. Any trace can spawn any amount of child traces,
// e.g. ensemble model and BLS. This map holds
// ( trace id, stack of started spans ) pair and for each trase keeps
// started spans alive for the duration of the traced
// event and helps to preserve parent-child relationship.
std::unordered_map<
uint64_t, std::unique_ptr<std::stack<
opentelemetry::nostd::shared_ptr<otel_trace_api::Span>>>>
span_stacks_;
// Root span. Some events should be recorded in the root span, while
// request span is still alive and present in the stack.
opentelemetry::nostd::shared_ptr<otel_trace_api::Span> root_span_;
/// Prepares trace context to propagate to TRITONSERVER_InferenceTrace.
/// Trace context follows W3C Trace Context specification.
/// Ref. https://www.w3.org/TR/trace-context/.
/// OpenTelemetry ref:
/// https://github.com/open-telemetry/opentelemetry-cpp/blob/4bd64c9a336fd438d6c4c9dad2e6b61b0585311f/api/include/opentelemetry/trace/propagation/http_trace_context.h#L94-L113
///
/// \param span An OpenTelemetry span, which is used to extract
/// OpenTelemetry's trace_id and span_id.
/// \param buffer Buffer used when writing JSON representation of
/// OpenTelemetry's context.
void PrepareTraceContext(
opentelemetry::nostd::shared_ptr<otel_trace_api::Span> span,
triton::common::TritonJson::WriteBuffer* buffer);
private:
// OpenTelemetry SDK relies on system's clock for event timestamps.
// Triton Tracing records timestamps using steady_clock. This is a
// monotonic clock, i.e. time is always moving forward. It is not related
// to wall clock time (for example, it can be time since last reboot).
// `time_offset_` is recorded when the trace instance is created,
// and further used to calculate `opentelemetry::common::SystemTimestamp`
// as `time_offset_` + std::chrono:nanoseconds{temestamp_ns}. This way,
// every event recorded timestamp will receive a timestamp of
// <time when the trace started> + <nanoseconds passed since the start>
// FIXME: add steady clock timestamps to Triton OpenTelemetry SDK,
// when created
const std::chrono::time_point<std::chrono::system_clock> time_offset_ =
std::chrono::system_clock::now() -
std::chrono::duration_cast<std::chrono::nanoseconds>(
std::chrono::steady_clock::now().time_since_epoch());
/// Starts a compute or request span based on `activity`.
/// For request spans, it will add the following attributes to the span:
/// `model_name`, `model_version`, `trace_id`, `parent_id`.
///
/// \param trace TRITONSERVER_InferenceTrace, used to request model's name,
/// version, trace parent_id from the backend.
/// \param activity Trace activity.
/// \param timestamp_ns Steady timestamp, which is used to calculate
/// OpenTelemetry SystemTimestamp to display span on a timeline, and
/// OpenTelemetry SteadyTimestamp to calculate the duration on the span
/// with better precision.
/// \param trace_id Trace id.
/// \param display_name Span name.
void StartSpan(
TRITONSERVER_InferenceTrace* trace,
TRITONSERVER_InferenceTraceActivity activity, uint64_t timestamp_ns,
uint64_t trace_id, std::string display_name);
/// Ends the span on the top of the stack, related to trace with `trace_id`.
///
/// \param trace_id Trace id.
void EndSpan(uint64_t trace_id);
/// Ends the span on the top of the stack, related to trace with `trace_id`
/// at specified steady timestamp.
///
/// \param raw_timestamp_ns Steady timestamp to use as
/// `EndSpanOptions::end_steady_time`.
/// \param trace_id Trace id.
void EndSpan(const uint64_t& raw_timestamp_ns, uint64_t trace_id);
/// Adds an event to the span on the top of the stack, related to trace
/// with `trace_id`. If activity is TRITONSERVER_TRACE_REQUEST_START,
/// or TRITONSERVER_TRACE_COMPUTE_START, starts a new span and adds it
/// to the span's stack.
///
/// \param trace TRITONSERVER_InferenceTrace, used to request model's name,
/// version, trace parent_id from the backend.
/// \param activity Trace activity.
/// \param timestamp_ns Timestamp of the provided event.
/// \param trace_id Trace id.
void AddEvent(
TRITONSERVER_InferenceTrace* trace,
TRITONSERVER_InferenceTraceActivity activity, uint64_t timestamp_ns,
uint64_t trace_id);
/// Adds an event to the OpenTelemetry span.
///
/// \param event An event to add to the span.
/// \param timestamp_ns Timestamp of the provided event.
/// \param trace_id Trace id.
void AddEvent(
const std::string& event, uint64_t timestamp_ns, uint64_t trace_id);
#endif
};
private:
TraceManager(
const TRITONSERVER_InferenceTraceLevel level, const uint32_t rate,
const int32_t count, const uint32_t log_frequency,
const std::string& filepath, const InferenceTraceMode mode,
const TraceConfigMap& config_map);
static void TraceActivity(
TRITONSERVER_InferenceTrace* trace,
TRITONSERVER_InferenceTraceActivity activity, uint64_t timestamp_ns,
void* userp);
static void TraceTensorActivity(
TRITONSERVER_InferenceTrace* trace,
TRITONSERVER_InferenceTraceActivity activity, const char* name,
TRITONSERVER_DataType datatype, const void* base, size_t byte_size,
const int64_t* shape, uint64_t dim_count,
TRITONSERVER_MemoryType memory_type, int64_t memory_type_id, void* userp);
// Helper function for UpdateTraceSetting() as recursive update may be needed
// if global setting is being updated
TRITONSERVER_Error* UpdateTraceSettingInternal(
const std::string& model_name, const NewSetting& new_setting);
class TraceFile {
public:
TraceFile(const std::string& file_name)
: file_name_(file_name), index_(0), first_write_(true)
{
}
~TraceFile();
// Save the traces stored in 'trace_stream' into the file. 'to_index_file'
// specifies whether the file name should be indexed, if true, the traces
// will be written to 'file_name.index' where index will be incremented
// every time the traces are written to a file with index. If false, the
// trace will be written to 'file_name'.
void SaveTraces(std::stringstream& trace_stream, const bool to_index_file);
const std::string& FileName() { return file_name_; }
private:
const std::string file_name_;
// The file index for the next index file write.
std::atomic<uint32_t> index_;
// Multiple traces may be finished and write to the trace file at the same
// time
std::mutex mu_;
std::ofstream trace_file_;
bool first_write_;
};
class TraceSetting {
public:
TraceSetting()
: level_(TRITONSERVER_TRACE_LEVEL_DISABLED), rate_(0), count_(-1),
log_frequency_(0), mode_(TRACE_MODE_TRITON), level_specified_(false),
rate_specified_(false), count_specified_(false),
log_frequency_specified_(false), filepath_specified_(false),
mode_specified_(false), config_map_specified_(false), sample_(0),
created_(0), collected_(0), sample_in_stream_(0)
{
invalid_reason_ = "Setting hasn't been initialized";
}
TraceSetting(
const TRITONSERVER_InferenceTraceLevel level, const uint32_t rate,
const int32_t count, const uint32_t log_frequency,
const std::shared_ptr<TraceFile>& file, const InferenceTraceMode mode,
const TraceConfigMap& config_map, const bool level_specified,
const bool rate_specified, const bool count_specified,
const bool log_frequency_specified, const bool filepath_specified,
const bool mode_specified, const bool config_map_specified);
~TraceSetting();
bool Valid() { return invalid_reason_.empty() && (count_ != 0); }
const std::string& Reason() { return invalid_reason_; }
void WriteTrace(
const std::unordered_map<uint64_t, std::unique_ptr<std::stringstream>>&
streams);
// Pass `force_sample` = true, when trace needs to be initiated
// no matter what `rate` and `count` is.
// For example, in OpenTelemetry tracing mode, we always initiate tracing
// when OpenTelemetry context was propagated from client.
std::shared_ptr<Trace> SampleTrace(bool force_sample = false);
const TRITONSERVER_InferenceTraceLevel level_;
const uint32_t rate_;
int32_t count_;
const uint32_t log_frequency_;
const std::shared_ptr<TraceFile> file_;
const InferenceTraceMode mode_;
const TraceConfigMap config_map_;
// Whether the field value is specified or mirror from upper level setting
const bool level_specified_;
const bool rate_specified_;
const bool count_specified_;
const bool log_frequency_specified_;
const bool filepath_specified_;
const bool mode_specified_;
const bool config_map_specified_;
private:
std::string invalid_reason_;
std::mutex mu_;
// use to sample a trace based on sampling rate.
uint64_t sample_;
// use to track the status of trace count feature
uint64_t created_;
uint64_t collected_;
// Tracking traces that haven't been saved to file
uint32_t sample_in_stream_;
std::stringstream trace_stream_;
};
// Trace settings
// Note that 'global_default_' doesn't use for actual trace sampling,
// it is used to revert the field values when clearing fields in
// 'global_setting_'
std::unique_ptr<TraceSetting> global_default_;
std::shared_ptr<TraceSetting> global_setting_;
std::unordered_map<std::string, std::shared_ptr<TraceSetting>>
model_settings_;
// The collection of models that have their own trace setting while
// some of the fields are mirroring global setting.
std::set<std::string> fallback_used_models_;
// The collection of files that are used in trace settings, use to
// avoid creating duplicate TraceFile objects for the same file path.
std::unordered_map<std::string, std::weak_ptr<TraceFile>> trace_files_;
// lock for accessing trace setting. 'w_mu_' for write and
// 'r_mu_' for read / write
std::mutex w_mu_;
std::mutex r_mu_;
};
}} // namespace triton::server