refactor: update interface types

Author: silva-fabio

packages/opencensus-core/src/exporters/buffer.ts

@@ -17,8 +17,8 @@
 import * as uuidv4 from 'uuid/v4';
 
 import {debug} from '../internal/util';
-import {RootSpan} from '../trace/model/rootspan';
-import {OnEndSpanEventListener} from '../trace/types/tracetypes';
+import {RootSpan} from '../trace/types';
+import {OnEndSpanEventListener} from '../trace/types';
 
 import {Exporter} from './exporter';
 import {ExporterOptions} from './exporterOptions';

packages/opencensus-core/src/exporters/exporter.ts

@@ -15,8 +15,8 @@
  */
 
 
-import {RootSpan} from '../trace/model/rootspan';
-import {OnEndSpanEventListener} from '../trace/types/tracetypes';
+import {RootSpan} from '../trace/types';
+import {OnEndSpanEventListener} from '../trace/types';
 import {ExporterOptions} from './exporterOptions';
 
 export interface Exporter { publish(rootSpans: RootSpan[]); }

packages/opencensus-core/src/index.ts

@@ -21,9 +21,9 @@ export * from './exporters/exporterOptions';
 export * from './internal/clock';
 export * from './internal/util';
 export * from './trace/config/sampler';
-export * from './trace/instrumentation/plugingtypes';
+export * from './trace/instrumentation/types';
 export * from './trace/model/rootspan';
 export * from './trace/model/span';
 export * from './trace/model/tracer';
-export * from './trace/types/tracetypes';
+export * from './trace/types';
 

packages/opencensus-core/src/trace/model/span-base-model.ts

@@ -1,12 +1,12 @@
 import { Clock } from '../../internal/clock';
 import { debug, randomSpanId } from '../../internal/util';
 import { Sampler } from '../config/sampler';
-import { TraceContext } from '../types';
+import { TraceContext, Span } from '../types';
 
 export interface MapLabels { [propName: string]: string; }
 export interface MapObjects { [propName: string]: any; }
 
-export abstract class SpanBaseModel {
+export abstract class SpanBaseModel implements Span {
     protected className: string;
     /** The clock used to mesure the beginning and ending of a span */
     private clock: Clock = null;

packages/opencensus-core/src/trace/model/tracer.ts

@@ -19,9 +19,9 @@ import { RootSpanImpl } from './rootspan';
 import { SpanImpl } from './span';
 import { debug } from '../../internal/util';
 import { Sampler } from '../config/sampler';
-import { TraceOptions, TracerConfig, defaultConfig, Tracer, OnEndSpanEventListener } from '../types';
+import { TraceOptions, TracerConfig, defaultConfig, Tracer, OnEndSpanEventListener, Func } from '../types';
 
-export type Func<T> = (...args: any[]) => T;
+//ßexport type Func<T> = (...args: any[]) => T;
 
 export class TracerImpl implements Tracer {
 

…ensus-core/src/trace/types/tracetypes.ts …kages/opencensus-core/src/trace/types.tspackages/opencensus-core/src/trace/types/tracetypes.ts renamed to packages/opencensus-core/src/trace/types.ts packages/opencensus-core/src/trace/types/tracetypes.ts renamed to packages/opencensus-core/src/trace/types.ts

@@ -15,7 +15,6 @@
  */
 
 import { Sampler } from './config/sampler';
-import { SpanBaseModel } from './model/spanbasemodel';
 
 /** Default type for functions */
 export type Func<T> = (...args: any[]) => T;
@@ -63,11 +62,6 @@ export interface TraceOptions {
   type?: string;
 }
 
-/** Defines an end span event listener */
-export interface OnEndSpanEventListener {
-  /** Happens when a span is ended */
-  onEndSpan(span: SpanBaseModel): void;
-}
 
 /** Defines the span data */
 export interface SpanData {
@@ -81,32 +75,83 @@ export interface SpanData {
   parentSpanId?: string;
 }
 
-/** Interface for RootSpan */
-export interface RootSpan {
-    /** Get the span list from RootSpan instance */
-    readonly spans: Span[];
-
-    /** Start the RootSpan instance */
-    start(): void;
-    /** End the RootSpan instance */
-    end(): void;
-    /** Start a new Span instance in the RootSpan instance */
-    startSpan(name: string, type: string, parentSpanId?: string): Span;
-}
 
 /** Interface for Span */
 export interface Span {
-    /** Gets the traceId from span instance */
+  
+    /** The Span ID of this span */
+    readonly id: string;
+    remoteParent: string;
+    /** The span ID of this span's parent. If it's a root span, must be empty */
+    parentSpanId: string;
+    /** The resource name of the span */
+    name: string;
+    /** Type of span. Used to specify additional relationships between spans */
+    type: string;
+    /** A final status for this span */
+    status: number;
+    /** A sampler that will decide if the span will be sampled or not */
+    sampler: Sampler;
+    /** Constructs a new SpanBaseModel instance. */
     readonly traceId: string;
-    /** Gets the parentSpanId from span instance */
-    readonly parentSpanId: string;
-    /** Gets the traceContext from span instance */
+    /** Indicates if span was started. */
+    readonly started: boolean;
+    /** Indicates if span was ended. */
+    readonly ended: boolean;
+    /**
+     * Gives a timestap that indicates the span's start time in RFC3339 UTC
+     * "Zulu" format.
+     */
+    readonly startTime: Date;
+    /**
+     * Gives a timestap that indicates the span's end time in RFC3339 UTC
+     * "Zulu" format.
+     */
+    readonly endTime: Date;
+    /**
+     * Gives a timestap that indicates the span's duration in RFC3339 UTC
+     * "Zulu" format.
+     */
+    readonly duration: number;
+    /** Gives the TraceContext of the span. */
     readonly traceContext: TraceContext;
-
-    /** Starts a span instance. */
+    /**
+     * Adds an atribute to the span.
+     * @param key Describes the value added.
+     * @param value The result of an operation.
+     */
+    addAtribute(key: string, value: string): void;
+    /**
+     * Adds an annotation to the span.
+     * @param key Describes the value added.
+     * @param value The result of an operation.
+     */
+    addAnotation(key: string, value: string | number | boolean): void;
+    /** Starts a span. */
     start(): void;
     /** Ends a span. */
     end(): void;
+    /** Forces to end a span. */
+    truncate(): void;
+}
+
+/** Interface for RootSpan */
+export interface RootSpan extends Span {
+  /** Get the span list from RootSpan instance */
+  readonly spans: Span[];
+
+  /** Start the RootSpan instance */
+  start(): void;
+  /** End the RootSpan instance */
+  end(): void;
+  /** Start a new Span instance in the RootSpan instance */
+  startSpan(name: string, type: string, parentSpanId?: string): Span;
+}
+
+/** Defines an end span event listener */
+export interface OnEndSpanEventListener {
+  /** Happens when a span is ended */
+  onEndSpan(span: Span): void;
 }
 
 /** Interface for Tracer */