@dx-do/client 6.1.0 → 6.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,13 +1,32 @@
1
1
  export declare namespace LogIngest {
2
+ interface LogIngestOptions {
3
+ /** Log type — matched against the tenant's configured log types (default: `"generic"`). */
4
+ logtype?: string;
5
+ /** Host name (default: auto-detected via `os.hostname()`). */
6
+ host?: string;
7
+ /** Log message text. */
8
+ message: string;
9
+ /** ISO 8601 timestamp (default: now). */
10
+ timestamp?: string;
11
+ /** Agent name sent as `__agent_name` (default: `"Logs Collector"`). */
12
+ agentName?: string;
13
+ /** Agent instance identifier sent as `__agent_instance` (default: `"dx-do"`). */
14
+ agentInstance?: string;
15
+ /** Container ID for the log entry (default: same as host). */
16
+ containerId?: string;
17
+ /** Container name for the log entry (default: same as agentInstance). */
18
+ containerName?: string;
19
+ /** Source file label (default: `"dx-do.cli"`). */
20
+ file?: string;
21
+ /** Source IP address (default: first non-loopback IPv4, falls back to `"127.0.0.1"`). */
22
+ ip?: string;
23
+ }
24
+ /** @deprecated Use {@link LogIngestOptions} with a separate `additionalFields` argument. */
2
25
  interface LogEntry {
3
26
  logtype: string;
4
27
  timestamp?: string;
5
28
  message?: string;
6
29
  [key: string]: unknown;
7
30
  }
8
- interface LogEntryWire extends LogEntry {
9
- tenant_id: string;
10
- timestamp: string;
11
- }
12
31
  }
13
32
  //# sourceMappingURL=ingest.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ingest.d.ts","sourceRoot":"","sources":["../../../../../src/lib/model/log/ingest.ts"],"names":[],"mappings":"AAAA,yBAAiB,SAAS,CAAC;IACzB,UAAiB,QAAQ;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB;IAED,UAAiB,YAAa,SAAQ,QAAQ;QAC5C,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;KACnB;CACF"}
1
+ {"version":3,"file":"ingest.d.ts","sourceRoot":"","sources":["../../../../../src/lib/model/log/ingest.ts"],"names":[],"mappings":"AAAA,yBAAiB,SAAS,CAAC;IACzB,UAAiB,gBAAgB;QAC/B,2FAA2F;QAC3F,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,8DAA8D;QAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,wBAAwB;QACxB,OAAO,EAAE,MAAM,CAAC;QAChB,yCAAyC;QACzC,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,uEAAuE;QACvE,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,iFAAiF;QACjF,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,8DAA8D;QAC9D,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,yEAAyE;QACzE,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,kDAAkD;QAClD,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,yFAAyF;QACzF,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;IAED,4FAA4F;IAC5F,UAAiB,QAAQ;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB;CACF"}
@@ -10,14 +10,20 @@ export declare class LogsService {
10
10
  constructor(dxSaasService: DxSaasService);
11
11
  /** Executes a log query against the OI log analytics filter API. */
12
12
  queryLogs(logQueryBody: LogQuery.LogQueryRequestBody): Promise<LogQuery.LogQueryResponseBody>;
13
- /** Ingests a single log entry into the log gateway. */
14
- ingestLog(entry: LogIngest.LogEntry): Promise<unknown>;
15
13
  /**
16
- * Builds the enriched payload array that will be sent to the uim_logs endpoint.
17
- * Exposed so callers can inspect the payload without sending (e.g. dry-run).
14
+ * Builds the enriched payload object for a single log entry.
15
+ *
16
+ * @param options - Known log entry fields (all optional with sensible defaults).
17
+ * @param additionalFields - Arbitrary extra fields to include in the indexed document.
18
+ * @returns The payload object ready to POST to the uim_logs ingestion endpoint.
18
19
  */
19
- buildLogPayload(entries: LogIngest.LogEntry[]): unknown[];
20
+ buildLogPayload(options: LogIngest.LogIngestOptions, additionalFields?: Record<string, unknown>): unknown;
21
+ /** Ingests a single log entry into the log gateway. */
22
+ ingestLog(options: LogIngest.LogIngestOptions, additionalFields?: Record<string, unknown>): Promise<unknown>;
20
23
  /** Ingests a batch of log entries into the log gateway. */
21
- ingestLogs(entries: LogIngest.LogEntry[]): Promise<unknown>;
24
+ ingestLogs(entries: Array<{
25
+ options: LogIngest.LogIngestOptions;
26
+ additionalFields?: Record<string, unknown>;
27
+ }>): Promise<unknown>;
22
28
  }
23
29
  //# sourceMappingURL=logs.service.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"logs.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/logs.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAehD;;GAEG;AACH,qBAAa,WAAW;IAEV,OAAO,CAAC,QAAQ,CAAC,aAAa;IAD1C,iDAAiD;gBACpB,aAAa,EAAE,aAAa;IAEzD,oEAAoE;IAC7D,SAAS,CAAC,YAAY,EAAE,QAAQ,CAAC,mBAAmB;IAO3D,uDAAuD;IAChD,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAI7D;;;OAGG;IACI,eAAe,CAAC,OAAO,EAAE,SAAS,CAAC,QAAQ,EAAE,GAAG,OAAO,EAAE;IA4ChE,2DAA2D;IACpD,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,QAAQ,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAMnE"}
1
+ {"version":3,"file":"logs.service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/logs.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAehD;;GAEG;AACH,qBAAa,WAAW;IAEV,OAAO,CAAC,QAAQ,CAAC,aAAa;IAD1C,iDAAiD;gBACpB,aAAa,EAAE,aAAa;IAEzD,oEAAoE;IAC7D,SAAS,CAAC,YAAY,EAAE,QAAQ,CAAC,mBAAmB;IAO3D;;;;;;OAMG;IACI,eAAe,CACpB,OAAO,EAAE,SAAS,CAAC,gBAAgB,EACnC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO;IAuCV,uDAAuD;IAChD,SAAS,CACd,OAAO,EAAE,SAAS,CAAC,gBAAgB,EACnC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,OAAO,CAAC;IAOnB,2DAA2D;IACpD,UAAU,CACf,OAAO,EAAE,KAAK,CAAC;QACb,OAAO,EAAE,SAAS,CAAC,gBAAgB,CAAC;QACpC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAC5C,CAAC,GACD,OAAO,CAAC,OAAO,CAAC;CAMpB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dx-do/client",
3
- "version": "6.1.0",
3
+ "version": "6.1.1",
4
4
  "description": "Opinionated TS client library for DX O2",
5
5
  "author": "Ki Alam",
6
6
  "logo": {