Trace.h File Reference

#include "support/Context.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/Twine.h"
#include "llvm/Support/JSON.h"
#include "llvm/Support/raw_ostream.h"
#include <chrono>
#include <string>
#include <vector>

Go to the source code of this file.

Classes
struct	clang::clangd::trace::Metric
	Represents measurements of clangd events, e.g. More...
class	clang::clangd::trace::EventTracer
	A consumer of trace events and measurements. More...
class	clang::clangd::trace::Session
	Sets up a global EventTracer that consumes events produced by Span and trace::log. More...
class	clang::clangd::trace::Span
	Records an event whose duration is the lifetime of the Span object. More...

Namespaces
namespace	clang
	===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
namespace	clang::clangd
	FIXME: Skip testing on windows temporarily due to the different escaping code mode.
namespace	clang::clangd::trace

Macros
#define	SPAN_ATTACH(S, Name, Expr)
	Attach a key-value pair to a Span event.

Functions
std::unique_ptr< EventTracer >	clang::clangd::trace::createJSONTracer (llvm::raw_ostream &OS, bool Pretty=false)
	Create an instance of EventTracer that produces an output in the Trace Event format supported by Chrome's trace viewer (chrome://tracing).
std::unique_ptr< EventTracer >	clang::clangd::trace::createCSVMetricTracer (llvm::raw_ostream &OS)
	Create an instance of EventTracer that outputs metric measurements as CSV.
void	clang::clangd::trace::log (const llvm::Twine &Name)
	Records a single instant event, associated with the current thread.
bool	clang::clangd::trace::enabled ()
	Returns true if there is an active tracer.

Macro Definition Documentation

SPAN_ATTACH

#define SPAN_ATTACH	(		S,
			Name,
			Expr
	)

Value:

  do {                                                                         \
    if (auto *Args = (S).Args)                                                 \
      (*Args)[Name] = Expr;                                                    \
  } while (0)

Attach a key-value pair to a Span event.

This is not threadsafe when used with the same Span.

Definition at line 164 of file Trace.h.