Skip to main content

TraceGraph

from v9.4status Work-in-Progress

TraceGraph is the runtime class for loaded Arrow-backed trace data. It owns ref lookup, visible graph projection, filter state, dependency traversal, search, and the metadata layout/rendering need.

import {TraceGraph} from '@deck.gl-community/trace-layers/trace';

Construction​

Construct it from a TraceGraphRuntimeSource. For static normalized data, use createStaticTraceGraphRuntimeSource(...). For custom runtime sources, use createTraceGraphRuntimeSource(...).

const graph = new TraceGraph(runtimeSource, {
  spanFilters,
  overlappingParentSpanFilter,
  similarDurationChainSpanFilter
});

What it owns​

  • loaded chunks and graph-wide metadata
  • process-local span-ref indexes
  • source and visible dependency lookup
  • process, thread, span, event, instant, and counter accessors
  • span filter masks and filter reasons
  • search and hidden-span navigation
  • visible render sources consumed by layout and cards

Method groups​

Use exact ref methods when you already have a SpanRef:

  • spanIsFiltered(...)
  • spanFilterReason(...)
  • getProcessRefBySpanRef(...)
  • getThreadRefBySpanRef(...)
  • getDependencyChainBySpanRef(...)
  • getTraceSpanCardModel(...)

Use visible graph methods for layout/render work:

  • getVisibleProcessRefs(...)
  • getVisibleProcessRenderSpans(...)
  • getVisibleLocalDependencySources(...)
  • getVisibleCrossDependencySources(...)
  • getVisiblePathData(...)

Use search and navigation methods for UI:

  • searchSpans(...)
  • getTraceSpanFilterNavigation(...)
  • getTraceSpanFilteredParentRef(...)

Rebuild rule​

Rebuild the graph when loaded data or filter semantics change. Reuse it when only collapse state, timing projection, geometry, color, or other render settings change.

See Filtering traces and TraceLayout.