logologo
Get Started
Guide
Development
Plugins
API
English
简体中文
Get Started
Guide
Development
Plugins
API
English
简体中文
logologo
API Overview

@nocobase/auth

AuthManager
Auth
BaseAuth

@nocobase/cli

NocoBase CLI
Global Environment Variables

@nocobase/client

Application
Plugin

@nocobase/database

Collection
Field

interfaces

BaseInterface
Filter Operators

RelationRepository

BelongsToManyRepository
belongs-to-repository
HasManyRepository
HasOneRepository
Repository

shared

create-options
destroy-options
find-one
find-options
transaction
update-options

@nocobase/flow-engine

DataSourceManager
FlowContext
FlowEngine
FlowModel
FlowResource

@nocobase/server

AppCommand
Application
AuditManager
Context
Migration
Plugin

@nocobase/sdk

Auth
Storage

@nocobase/telemetry

Metric
Telemetry
Trace
Previous PageTelemetry

#Trace

#Class Methods

#constructor()

Constructor to create a Trace instance.

#Signature

  • constructor(options?: TraceOptions)

#Type

export type TraceOptions = {
  tracerName?: string;
  version?: string;
  processorName?: string | string[];
};

#Details

PropertyTypeDescriptionDefault Value
tracerNamestringTrace identifiernocobase-trace
versionstringCurrent version of NocoBase
processorNamestring | string[]Identifier(s) of registered SpanProcessor to use-

#init()

Initializes NodeTracerProvider.

#Signature

  • init(): void

#registerProcessor()

Registers a SpanProcessor.

#Signature

  • registerProcessor(name: string, processor: GetSpanProcessor)

#Type

import { SpanProcessor } from '@opentelemetry/sdk-trace-base';

type GetSpanProcessor = () => SpanProcessor;

#Details

ParameterTypeDescription
namestringUnique identifier for SpanProcessor
processor() => SpanProcessorFunction to get SpanProcessor

#getTracer()

Gets the Tracer.

#Signature

  • getTracer(name?: string, version?: string)

#Details

ParameterTypeDescriptionDefault Value
namestringTrace identifiernocobase-trace
versionstringCurrent version of NocoBase

#start()

Starts the SpanProcessor.

#Signature

  • start(): void

#shutdown()

Stops the SpanProcessor.

#Signature

  • shutdown(): Promise<void>