@apinecka/logs-client 1.0.0 → 1.1.0
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.
- package/README.md +133 -14
- package/dist/client.d.ts +60 -1
- package/dist/client.js +345 -2
- package/dist/client.js.map +1 -1
- package/dist/conform.d.ts +39 -0
- package/dist/conform.js +187 -0
- package/dist/conform.js.map +1 -0
- package/dist/context.d.ts +60 -0
- package/dist/context.js +118 -0
- package/dist/context.js.map +1 -0
- package/dist/error.d.ts +8 -0
- package/dist/error.js +58 -0
- package/dist/error.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/dist/nest/logs.logger.d.ts +25 -2
- package/dist/nest/logs.logger.js +154 -18
- package/dist/nest/logs.logger.js.map +1 -1
- package/dist/schema/models/createLog.d.ts +31 -0
- package/dist/schema/models/createLogBatch.d.ts +15 -0
- package/dist/schema/models/createLogBatch.js +3 -0
- package/dist/schema/models/createLogBatch.js.map +1 -0
- package/dist/schema/models/createLogBatchResult.d.ts +13 -0
- package/dist/schema/models/createLogBatchResult.js +10 -0
- package/dist/schema/models/createLogBatchResult.js.map +1 -0
- package/dist/schema/models/createLogMeta.d.ts +13 -0
- package/dist/schema/models/createLogMeta.js +10 -0
- package/dist/schema/models/createLogMeta.js.map +1 -0
- package/dist/schema/models/createLogTags.d.ts +13 -0
- package/dist/schema/models/createLogTags.js +10 -0
- package/dist/schema/models/createLogTags.js.map +1 -0
- package/dist/schema/models/index.d.ts +12 -0
- package/dist/schema/models/index.js +12 -0
- package/dist/schema/models/index.js.map +1 -1
- package/dist/schema/models/logContexts.d.ts +15 -0
- package/dist/schema/models/logContexts.js +3 -0
- package/dist/schema/models/logContexts.js.map +1 -0
- package/dist/schema/models/logError.d.ts +21 -0
- package/dist/schema/models/logError.js +3 -0
- package/dist/schema/models/logError.js.map +1 -0
- package/dist/schema/models/logRequestContext.d.ts +28 -0
- package/dist/schema/models/logRequestContext.js +3 -0
- package/dist/schema/models/logRequestContext.js.map +1 -0
- package/dist/schema/models/logRequestContextHeaders.d.ts +13 -0
- package/dist/schema/models/logRequestContextHeaders.js +10 -0
- package/dist/schema/models/logRequestContextHeaders.js.map +1 -0
- package/dist/schema/models/logRequestContextQuery.d.ts +13 -0
- package/dist/schema/models/logRequestContextQuery.js +10 -0
- package/dist/schema/models/logRequestContextQuery.js.map +1 -0
- package/dist/schema/models/logRuntimeContext.d.ts +20 -0
- package/dist/schema/models/logRuntimeContext.js +10 -0
- package/dist/schema/models/logRuntimeContext.js.map +1 -0
- package/dist/schema/models/logStackFrame.d.ts +17 -0
- package/dist/schema/models/logStackFrame.js +10 -0
- package/dist/schema/models/logStackFrame.js.map +1 -0
- package/dist/schema/models/logUser.d.ts +13 -0
- package/dist/schema/models/logUser.js +10 -0
- package/dist/schema/models/logUser.js.map +1 -0
- package/dist/types.d.ts +50 -0
- package/package.json +1 -1
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Generated by orval 🍺
|
|
4
|
+
* Do not edit manually.
|
|
5
|
+
* Apinecka Logs API
|
|
6
|
+
* Apinecka Logs API
|
|
7
|
+
* OpenAPI spec version: 1.0.0
|
|
8
|
+
*/
|
|
9
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
|
+
//# sourceMappingURL=logStackFrame.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"logStackFrame.js","sourceRoot":"","sources":["../../../src/schema/models/logStackFrame.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"logUser.js","sourceRoot":"","sources":["../../../src/schema/models/logUser.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG"}
|
package/dist/types.d.ts
CHANGED
|
@@ -1,4 +1,40 @@
|
|
|
1
1
|
import type { CreateLog } from './schema/models';
|
|
2
|
+
/** Queue and batching limits of {@link LogsClient.enqueue}. */
|
|
3
|
+
export interface LogsBatchingOptions {
|
|
4
|
+
/** Entries held in memory; on overflow the oldest are dropped. Default 1000. */
|
|
5
|
+
maxQueueItems?: number;
|
|
6
|
+
/** JSON size of the queue; on overflow the oldest entries are dropped. Default 5 MB. */
|
|
7
|
+
maxQueueBytes?: number;
|
|
8
|
+
/** A batch is sent as soon as this many entries are queued. Default 100. */
|
|
9
|
+
maxBatchItems?: number;
|
|
10
|
+
/** JSON size budget of one batch request. Default 4 MB (the server accepts 5 MB). */
|
|
11
|
+
maxBatchBytes?: number;
|
|
12
|
+
/** Queued entries are flushed at least this often. Default 2000 ms. */
|
|
13
|
+
flushIntervalMs?: number;
|
|
14
|
+
}
|
|
15
|
+
/** Retry policy for failed batch requests (network errors, timeouts, 5xx). */
|
|
16
|
+
export interface LogsRetryOptions {
|
|
17
|
+
/** Retries of one batch before it is dropped. Default 8. */
|
|
18
|
+
maxRetries?: number;
|
|
19
|
+
/** Base of the exponential backoff (full jitter). Default 1000 ms. */
|
|
20
|
+
baseDelayMs?: number;
|
|
21
|
+
/** Cap of the backoff. Default 60000 ms. */
|
|
22
|
+
maxDelayMs?: number;
|
|
23
|
+
/** Pause after a 429 without a usable `Retry-After`. Default 30000 ms. */
|
|
24
|
+
rateLimitPauseMs?: number;
|
|
25
|
+
}
|
|
26
|
+
/** Flood protection of {@link LogsClient.enqueue}: repeated entries are collapsed into one with `meta._suppressed`. */
|
|
27
|
+
export interface LogsSamplingOptions {
|
|
28
|
+
/** Entries per key (level + context + error type + message start) that pass per window. Default 20. */
|
|
29
|
+
maxPerKey?: number;
|
|
30
|
+
/** Window length. Default 60000 ms. */
|
|
31
|
+
windowMs?: number;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Sends one request. Must throw an axios-like error (`response.status`, `response.headers`) on failure.
|
|
35
|
+
* Meant for tests; the default uses axios.
|
|
36
|
+
*/
|
|
37
|
+
export type LogsTransport = (path: string, body: unknown) => Promise<unknown>;
|
|
2
38
|
export interface LogsClientOptions {
|
|
3
39
|
/** Base URL of logs-api, e.g. `https://logs.apinecka.com`. */
|
|
4
40
|
baseUrl: string;
|
|
@@ -6,6 +42,20 @@ export interface LogsClientOptions {
|
|
|
6
42
|
apiKey?: string;
|
|
7
43
|
/** Per-request timeout, default 5000 ms. */
|
|
8
44
|
timeoutMs?: number;
|
|
45
|
+
/** App version added to entries without one. Default `process.env.LOGS_RELEASE ?? process.env.GIT_SHA`. */
|
|
46
|
+
release?: string;
|
|
47
|
+
/** Env added to entries without one (otherwise the env of the ingest token applies). */
|
|
48
|
+
env?: string;
|
|
49
|
+
/** Tags added to every entry (the entry's and the active context's own tags win). */
|
|
50
|
+
defaultTags?: Record<string, string>;
|
|
51
|
+
/** Attach `contexts.runtime` (host, pid, node version, memory, uptime) to enqueued entries. Default true. */
|
|
52
|
+
runtimeContext?: boolean;
|
|
53
|
+
batching?: LogsBatchingOptions;
|
|
54
|
+
retry?: LogsRetryOptions;
|
|
55
|
+
/** Flood protection, `false` disables it. */
|
|
56
|
+
sampling?: LogsSamplingOptions | false;
|
|
57
|
+
/** Replaces the HTTP transport (tests). */
|
|
58
|
+
transport?: LogsTransport;
|
|
9
59
|
}
|
|
10
60
|
/** @deprecated Name from the pre-package era, use {@link LogsClientOptions}. */
|
|
11
61
|
export type ApiClientOptions = LogsClientOptions;
|
package/package.json
CHANGED