aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/core/lib/channel/channel_tracer.h
blob: 42f6e5ccb85e8cb4822c7841694b0f18968269fb (plain)
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
/*
 *
 * Copyright 2017 gRPC authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#ifndef GRPC_CORE_LIB_CHANNEL_CHANNEL_TRACER_H
#define GRPC_CORE_LIB_CHANNEL_CHANNEL_TRACER_H

#include <grpc/grpc.h>
#include "src/core/lib/iomgr/error.h"
#include "src/core/lib/json/json.h"

namespace grpc_core {

class TraceEvent;

class ChannelTracer {
 public:
  ChannelTracer(size_t max_nodes);
  ~ChannelTracer() {}

  // TODO(ncteisen): incorporate RefCounted class
  ChannelTracer* Ref();
  void Unref();

  /* returns the tracers uuid */
  intptr_t GetUuid();

  /* Adds a new trace node to the tracing object */
  void AddTrace(grpc_slice data, grpc_error* error,
                grpc_connectivity_state connectivity_state,
                ChannelTracer* subchannel);

  /* Returns the tracing data rendered as a grpc json string.
     The string is owned by the caller and must be freed. If recursive
     is true, then the string will include the recursive trace for all
     subtracing objects. */
  char* RenderTrace(bool recursive);

  /* util functions that perform the uuid -> tracer step for you, and then
     returns the trace for the uuid given. */
  static char* GetChannelTraceFromUuid(intptr_t uuid, bool recursive);

 private:
  // Internal helper that frees a TraceEvent.
  void FreeNode(TraceEvent* node);

  friend class ChannelTracerRenderer;
  gpr_refcount refs_;
  gpr_mu tracer_mu_;
  intptr_t channel_uuid_;
  uint64_t num_nodes_logged_;
  uint64_t num_children_seen_;
  size_t list_size_;
  size_t max_list_size_;
  TraceEvent* head_trace_;
  TraceEvent* tail_trace_;
  gpr_timespec time_created_;
};

}  // namespace grpc_core

#endif /* GRPC_CORE_LIB_CHANNEL_CHANNEL_TRACER_H */