[#364] Exports AgentBuilder for Typescript projects

- Add AgentBuilder and AgentInfo exports to package.json
- Remove unused span.js and span-chunk.js files

Author: feelform

index.js

@@ -6,7 +6,7 @@
 
 'use strict'
 
-const AgentBuilder = require('./lib/agent-builder')
+const { AgentBuilder } = require('./lib/agent-builder')
 const AgentInfo = require('./lib/data/dto/agent-info')
 const { getConfig } = require('./lib/config')
 

lib/agent-builder.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Pinpoint Node.js Agent
+ * Copyright 2020-present NAVER Corp.
+ * Apache License v2.0
+ */
+
+import { PinpointConfig } from './config';
+import AgentInfo = require('./data/dto/agent-info');
+
+interface TraceObject {
+  [key: string]: any;
+}
+
+interface TraceContext {
+  newTraceObject2(): TraceObject;
+  currentTraceObject(): TraceObject | null;
+  completeTraceObject(trace: TraceObject): void;
+}
+
+interface DataSender {
+  send(data: any): void;
+  sendSupportedServicesCommand(): void;
+  [key: string]: any;
+}
+
+interface Agent {
+  agentInfo: AgentInfo;
+  config: PinpointConfig;
+  dataSender: DataSender;
+  traceContext: TraceContext;
+  services: Array<() => void>;
+
+  start(): void;
+  createTraceObject(): TraceObject;
+  currentTraceObject(): TraceObject | null;
+  completeTraceObject(trace: TraceObject): void;
+  getAgentInfo(): AgentInfo;
+  getTraceContext(): TraceContext;
+  shutdown(): void;
+}
+
+declare class AgentBuilder {
+  constructor(agentInfo: AgentInfo);
+
+  setConfig(config: PinpointConfig): AgentBuilder;
+  setDataSender(dataSender: DataSender): AgentBuilder;
+  addService(service: () => void): AgentBuilder;
+  disableStatsScheduler(): AgentBuilder;
+  disablePingScheduler(): AgentBuilder;
+  disableServiceCommand(): AgentBuilder;
+  build(): Agent;
+}
+
+export { Agent, AgentBuilder };

lib/agent-builder.js

@@ -154,4 +154,4 @@ class AgentBuilder {
     }
 }
 
-module.exports = AgentBuilder
+module.exports = { Agent, AgentBuilder }

lib/client/data-sender.js

@@ -10,8 +10,6 @@ const log = require('../utils/log/logger')
 const AgentInfo = require('../data/dto/agent-info')
 const ApiMetaInfo = require('../data/dto/api-meta-info')
 const StringMetaInfo = require('../data/dto/string-meta-info')
-const Span = require('../context/span')
-const SpanChunk = require('../context/span-chunk')
 const SqlMetaData = require('./sql-meta-data')
 const SqlUidMetaData = require('./sql-uid-meta-data')
 
@@ -45,13 +43,9 @@ class DataSender {
       this.dataSender.sendApiMetaInfo(data)
     } else if (data instanceof StringMetaInfo) {
       this.dataSender.sendStringMetaInfo(data)
-    } else if (data instanceof Span) {
-      this.dataSender.sendSpan(data)
     } else if (data?.isSpan?.()) {
       this.dataSender.sendSpan(data)
-    } else if (data instanceof SpanChunk) {
-      this.dataSender.sendSpanChunk(data)
-    } else if (data?.isAsyncSpanChunk?.()) {
+    } else if (data?.isSpanChunk?.()) {
       this.dataSender.sendSpanChunk(data)
     } else if (data instanceof SqlMetaData) {
       this.dataSender.sendSqlMetaInfo(data)

lib/config.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Pinpoint Node.js Agent
+ * Copyright 2020-present NAVER Corp.
+ * Apache License v2.0
+ */
+
+export interface LoggerLevels {
+  [loggerName: string]: string;
+}
+
+export interface PinpointConfig {
+  enable: boolean;
+  agentId: string;
+  agentName?: string;
+  applicationName: string;
+  serviceType: number;
+  container: boolean;
+  collectorIp: string;
+  collectorTcpPort: number;
+  collectorStatPort: number;
+  collectorSpanPort: number;
+  sampling: boolean;
+  sampleRate: number;
+  logLevel: string;
+  loggerLevels?: LoggerLevels;
+  enabledDataSending?: boolean;
+  enabledStatsMonitor: boolean;
+  enabledActiveThreadCount?: boolean;
+  express?: boolean;
+  koa?: boolean;
+  mongo?: boolean;
+  redis?: boolean;
+  traceExclusionUrlPatterns?: string[];
+  traceExclusionUrlCacheSize?: number;
+  streamDeadlineMinutesClientSide?: number;
+  traceLocationAndFileNameOfCallSite?: boolean;
+  profilerSqlStat?: boolean;
+  httpStatusCodeErrors?: string;
+  grpcServiceConfig?: { [key: string]: any };
+  [key: string]: any;
+}
+
+export declare function getConfig(initOptions?: { [key: string]: any }): PinpointConfig;
+export declare function clear(): void;
+export declare function readConfigJson(formattedConfig: any): Partial<PinpointConfig>;
+export declare function readRootConfigFile(): { [key: string]: any };
+export declare function getMainModulePath(requireFunction: NodeRequire): string | undefined;
+export declare function isContainerEnvironment(): boolean;
+export declare function initializeConfig(initOptions?: { [key: string]: any }): void;
+export declare function registerLoadedConfig(propertyName: string, callback: (value: any) => void): void;

lib/context/span-chunk.js

@@ -19,10 +19,6 @@ class AsyncSpanChunk extends SpanChunk {
         return this.localAsyncId
     }
 
-    isAsyncSpanChunk() {
-        return true
-    }
-
     toProtocolBuffer() {
         const pSpanMessage = super.toProtocolBuffer()
         const pSpanChunk = pSpanMessage.getSpanchunk()

lib/context/span.js

@@ -18,6 +18,10 @@ class SpanChunk {
         return this.traceRoot
     }
 
+    isSpanChunk() {
+        return true
+    }
+
     toProtocolBuffer() {
         const pSpanMessage = new spanMessages.PSpanMessage()
         const pSpanChunk = new spanMessages.PSpanChunk()

lib/context/trace/async-span-chunk-builder.js

@@ -0,0 +1,36 @@
+/**
+ * Pinpoint Node.js Agent
+ * Copyright 2020-present NAVER Corp.
+ * Apache License v2.0
+ */
+
+import { PinpointConfig } from '../../config';
+
+declare class AgentInfo {
+  agentId: string;
+  agentName: string;
+  applicationName: string;
+  serviceType: number;
+  applicationServiceType: number;
+  container: boolean;
+  agentStartTime: string;
+  agentVersion: string;
+  hostname: string;
+  ip: string;
+  pid: number;
+  ports: string;
+  vmVersion: string;
+
+  constructor(config: PinpointConfig, agentStartTime: string);
+
+  static make(config: PinpointConfig): AgentInfo;
+
+  getAgentId(): string;
+  getAgentName(): string;
+  getAgentStartTime(): string;
+  getServiceType(): number;
+  getApplicationName(): string;
+  getApplicationServiceType(): number;
+}
+
+export = AgentInfo;