@rawnodes/logger 2.4.0 → 2.5.0

package/README.md

@@ -272,7 +272,6 @@ const logger = Logger.create({
   console: { format: 'plain' },
   cloudwatch: {
     logGroupName: '/app/my-service',
-    logStreamName: `${hostname}-${Date.now()}`,
     region: 'us-east-1',
     accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
     secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
@@ -284,6 +283,91 @@ const logger = Logger.create({
 });
 ```
 
+#### Log Stream Name
+
+The `logStreamName` field is optional and supports multiple configuration formats:
+
+```typescript
+// Option 1: Static string
+cloudwatch: {
+  logGroupName: '/app/my-service',
+  logStreamName: 'my-static-stream',
+  // ...
+}
+
+// Option 2: Predefined pattern
+cloudwatch: {
+  logGroupName: '/app/my-service',
+  logStreamName: { pattern: 'hostname-date' },
+  // ...
+}
+
+// Option 3: Custom template
+cloudwatch: {
+  logGroupName: '/app/my-service',
+  logStreamName: { template: '{hostname}/{env}/{date}' },
+  // ...
+}
+
+// Option 4: Omit for default (hostname)
+cloudwatch: {
+  logGroupName: '/app/my-service',
+  // logStreamName defaults to hostname
+  // ...
+}
+```
+
+**Available patterns:**
+
+| Pattern | Example Output |
+|---------|----------------|
+| `hostname` | `my-server` |
+| `hostname-date` | `my-server/2025-01-15` |
+| `hostname-uuid` | `my-server-a1b2c3d4` |
+| `date` | `2025-01-15` |
+| `uuid` | `a1b2c3d4-e5f6-7890-abcd` |
+
+**Template variables:**
+
+| Variable | Description |
+|----------|-------------|
+| `{hostname}` | Server hostname (config.hostname → HOSTNAME env → os.hostname()) |
+| `{date}` | Current date (YYYY-MM-DD) |
+| `{datetime}` | Current datetime (YYYY-MM-DD-HH-mm-ss) |
+| `{uuid}` | 8-char UUID (generated once at startup) |
+| `{pid}` | Process ID |
+| `{env}` | NODE_ENV (default: "development") |
+
+**Hostname resolution priority:**
+1. `config.hostname` (from logger config)
+2. `process.env.HOSTNAME` (useful in Docker/Kubernetes)
+3. `os.hostname()`
+
+**Examples:**
+
+```typescript
+// Kubernetes-friendly: pod name as stream
+cloudwatch: {
+  logGroupName: '/app/my-service/production',
+  logStreamName: { pattern: 'hostname' },  // -> "my-app-pod-abc123"
+  // ...
+}
+
+// Daily rotation with hostname
+cloudwatch: {
+  logGroupName: '/app/my-service',
+  logStreamName: { pattern: 'hostname-date' },  // -> "my-server/2025-01-15"
+  // ...
+}
+
+// Custom format with environment
+cloudwatch: {
+  logGroupName: '/app/my-service',
+  logStreamName: { template: '{env}/{hostname}/{date}' },  // -> "production/my-server/2025-01-15"
+  // ...
+}
+```
+
 ### Transport Options
 
 All external transports support:

package/dist/index.d.mts

@@ -64,9 +64,19 @@ interface TelegramConfig extends HttpTransportBaseConfig {
     threadId?: number;
     replyToMessageId?: number;
 }
+type LogStreamPattern = 'hostname' | 'hostname-date' | 'hostname-uuid' | 'date' | 'uuid';
+interface LogStreamPatternConfig {
+    pattern: LogStreamPattern;
+}
+interface LogStreamTemplateConfig {
+    /** Custom template with variables: {hostname}, {date}, {datetime}, {uuid}, {pid}, {env} */
+    template: string;
+}
+type LogStreamName = string | LogStreamPatternConfig | LogStreamTemplateConfig;
 interface CloudWatchConfig extends HttpTransportBaseConfig {
     logGroupName: string;
-    logStreamName: string;
+    /** Log stream name - string, pattern config, or template config. Defaults to hostname pattern */
+    logStreamName?: LogStreamName;
     region: string;
     accessKeyId: string;
     secretAccessKey: string;
@@ -240,7 +250,8 @@ declare class CloudWatchTransport extends BaseHttpTransport {
     private sequenceToken;
     private initialized;
     private initPromise;
-    constructor(config: CloudWatchConfig);
+    private resolvedLogStreamName;
+    constructor(config: CloudWatchConfig, configHostname?: string);
     protected sendBatch(messages: BufferedMessage[]): Promise<void>;
     private ensureInitialized;
     private initialize;
@@ -296,6 +307,10 @@ declare const FileConfigSchema: z.ZodType<FileConfig>;
 declare const HttpTransportBaseConfigSchema: z.ZodType<HttpTransportBaseConfig>;
 declare const DiscordConfigSchema: z.ZodType<DiscordConfig>;
 declare const TelegramConfigSchema: z.ZodType<TelegramConfig>;
+declare const LogStreamPatternSchema: z.ZodType<LogStreamPattern>;
+declare const LogStreamPatternConfigSchema: z.ZodType<LogStreamPatternConfig>;
+declare const LogStreamTemplateConfigSchema: z.ZodType<LogStreamTemplateConfig>;
+declare const LogStreamNameSchema: z.ZodType<LogStreamName>;
 declare const CloudWatchConfigSchema: z.ZodType<CloudWatchConfig>;
 declare const LevelConfigObjectSchema: z.ZodType<LevelConfigObject>;
 declare const LevelConfigSchema: z.ZodType<LevelConfig>;
@@ -322,4 +337,4 @@ declare function safeValidateConfig(config: unknown): z.ZodSafeParseResult<{
     hostname?: string | undefined;
 }>;
 
-export { BaseHttpTransport, type BaseHttpTransportOptions, type BufferOptions, type BufferedMessage, type CallerConfig, CallerConfigSchema, type CallerInfo, type CloudWatchConfig, CloudWatchConfigSchema, CloudWatchTransport, type ConsoleConfig, ConsoleConfigSchema, type DiscordConfig, DiscordConfigSchema, DiscordTransport, type FileConfig, FileConfigSchema, type HttpTransportBaseConfig, HttpTransportBaseConfigSchema, LOG_LEVELS, type LevelConfig, type LevelConfigObject, LevelConfigObjectSchema, LevelConfigSchema, type LevelOverride, type LevelOverrideMatch, type LevelRule, LevelRuleSchema, type LogFormat, LogFormatSchema, type LogLevel, LogLevelSchema, Logger, type LoggerConfig, LoggerConfigSchema, type LoggerContext, LoggerStore, type MaskSecretsOptions, MessageBuffer, type Meta, type RequestIdOptions, type SingletonLogger, type TelegramConfig, TelegramConfigSchema, TelegramTransport, type TimingResult, assertLogLevel, createMasker, createSingletonLogger, extractRequestId, flattenObject, formatCallerInfo, formatLogfmt, formatLogfmtValue, generateRequestId, getCallerInfo, getOrGenerateRequestId, isValidLogLevel, maskSecrets, matchesContext, measureAsync, measureSync, safeValidateConfig, validateConfig };
+export { BaseHttpTransport, type BaseHttpTransportOptions, type BufferOptions, type BufferedMessage, type CallerConfig, CallerConfigSchema, type CallerInfo, type CloudWatchConfig, CloudWatchConfigSchema, CloudWatchTransport, type ConsoleConfig, ConsoleConfigSchema, type DiscordConfig, DiscordConfigSchema, DiscordTransport, type FileConfig, FileConfigSchema, type HttpTransportBaseConfig, HttpTransportBaseConfigSchema, LOG_LEVELS, type LevelConfig, type LevelConfigObject, LevelConfigObjectSchema, LevelConfigSchema, type LevelOverride, type LevelOverrideMatch, type LevelRule, LevelRuleSchema, type LogFormat, LogFormatSchema, type LogLevel, LogLevelSchema, type LogStreamName, LogStreamNameSchema, type LogStreamPattern, type LogStreamPatternConfig, LogStreamPatternConfigSchema, LogStreamPatternSchema, type LogStreamTemplateConfig, LogStreamTemplateConfigSchema, Logger, type LoggerConfig, LoggerConfigSchema, type LoggerContext, LoggerStore, type MaskSecretsOptions, MessageBuffer, type Meta, type RequestIdOptions, type SingletonLogger, type TelegramConfig, TelegramConfigSchema, TelegramTransport, type TimingResult, assertLogLevel, createMasker, createSingletonLogger, extractRequestId, flattenObject, formatCallerInfo, formatLogfmt, formatLogfmtValue, generateRequestId, getCallerInfo, getOrGenerateRequestId, isValidLogLevel, maskSecrets, matchesContext, measureAsync, measureSync, safeValidateConfig, validateConfig };

package/dist/index.d.ts

@@ -64,9 +64,19 @@ interface TelegramConfig extends HttpTransportBaseConfig {
     threadId?: number;
     replyToMessageId?: number;
 }
+type LogStreamPattern = 'hostname' | 'hostname-date' | 'hostname-uuid' | 'date' | 'uuid';
+interface LogStreamPatternConfig {
+    pattern: LogStreamPattern;
+}
+interface LogStreamTemplateConfig {
+    /** Custom template with variables: {hostname}, {date}, {datetime}, {uuid}, {pid}, {env} */
+    template: string;
+}
+type LogStreamName = string | LogStreamPatternConfig | LogStreamTemplateConfig;
 interface CloudWatchConfig extends HttpTransportBaseConfig {
     logGroupName: string;
-    logStreamName: string;
+    /** Log stream name - string, pattern config, or template config. Defaults to hostname pattern */
+    logStreamName?: LogStreamName;
     region: string;
     accessKeyId: string;
     secretAccessKey: string;
@@ -240,7 +250,8 @@ declare class CloudWatchTransport extends BaseHttpTransport {
     private sequenceToken;
     private initialized;
     private initPromise;
-    constructor(config: CloudWatchConfig);
+    private resolvedLogStreamName;
+    constructor(config: CloudWatchConfig, configHostname?: string);
     protected sendBatch(messages: BufferedMessage[]): Promise<void>;
     private ensureInitialized;
     private initialize;
@@ -296,6 +307,10 @@ declare const FileConfigSchema: z.ZodType<FileConfig>;
 declare const HttpTransportBaseConfigSchema: z.ZodType<HttpTransportBaseConfig>;
 declare const DiscordConfigSchema: z.ZodType<DiscordConfig>;
 declare const TelegramConfigSchema: z.ZodType<TelegramConfig>;
+declare const LogStreamPatternSchema: z.ZodType<LogStreamPattern>;
+declare const LogStreamPatternConfigSchema: z.ZodType<LogStreamPatternConfig>;
+declare const LogStreamTemplateConfigSchema: z.ZodType<LogStreamTemplateConfig>;
+declare const LogStreamNameSchema: z.ZodType<LogStreamName>;
 declare const CloudWatchConfigSchema: z.ZodType<CloudWatchConfig>;
 declare const LevelConfigObjectSchema: z.ZodType<LevelConfigObject>;
 declare const LevelConfigSchema: z.ZodType<LevelConfig>;
@@ -322,4 +337,4 @@ declare function safeValidateConfig(config: unknown): z.ZodSafeParseResult<{
     hostname?: string | undefined;
 }>;
 
-export { BaseHttpTransport, type BaseHttpTransportOptions, type BufferOptions, type BufferedMessage, type CallerConfig, CallerConfigSchema, type CallerInfo, type CloudWatchConfig, CloudWatchConfigSchema, CloudWatchTransport, type ConsoleConfig, ConsoleConfigSchema, type DiscordConfig, DiscordConfigSchema, DiscordTransport, type FileConfig, FileConfigSchema, type HttpTransportBaseConfig, HttpTransportBaseConfigSchema, LOG_LEVELS, type LevelConfig, type LevelConfigObject, LevelConfigObjectSchema, LevelConfigSchema, type LevelOverride, type LevelOverrideMatch, type LevelRule, LevelRuleSchema, type LogFormat, LogFormatSchema, type LogLevel, LogLevelSchema, Logger, type LoggerConfig, LoggerConfigSchema, type LoggerContext, LoggerStore, type MaskSecretsOptions, MessageBuffer, type Meta, type RequestIdOptions, type SingletonLogger, type TelegramConfig, TelegramConfigSchema, TelegramTransport, type TimingResult, assertLogLevel, createMasker, createSingletonLogger, extractRequestId, flattenObject, formatCallerInfo, formatLogfmt, formatLogfmtValue, generateRequestId, getCallerInfo, getOrGenerateRequestId, isValidLogLevel, maskSecrets, matchesContext, measureAsync, measureSync, safeValidateConfig, validateConfig };
+export { BaseHttpTransport, type BaseHttpTransportOptions, type BufferOptions, type BufferedMessage, type CallerConfig, CallerConfigSchema, type CallerInfo, type CloudWatchConfig, CloudWatchConfigSchema, CloudWatchTransport, type ConsoleConfig, ConsoleConfigSchema, type DiscordConfig, DiscordConfigSchema, DiscordTransport, type FileConfig, FileConfigSchema, type HttpTransportBaseConfig, HttpTransportBaseConfigSchema, LOG_LEVELS, type LevelConfig, type LevelConfigObject, LevelConfigObjectSchema, LevelConfigSchema, type LevelOverride, type LevelOverrideMatch, type LevelRule, LevelRuleSchema, type LogFormat, LogFormatSchema, type LogLevel, LogLevelSchema, type LogStreamName, LogStreamNameSchema, type LogStreamPattern, type LogStreamPatternConfig, LogStreamPatternConfigSchema, LogStreamPatternSchema, type LogStreamTemplateConfig, LogStreamTemplateConfigSchema, Logger, type LoggerConfig, LoggerConfigSchema, type LoggerContext, LoggerStore, type MaskSecretsOptions, MessageBuffer, type Meta, type RequestIdOptions, type SingletonLogger, type TelegramConfig, TelegramConfigSchema, TelegramTransport, type TimingResult, assertLogLevel, createMasker, createSingletonLogger, extractRequestId, flattenObject, formatCallerInfo, formatLogfmt, formatLogfmtValue, generateRequestId, getCallerInfo, getOrGenerateRequestId, isValidLogLevel, maskSecrets, matchesContext, measureAsync, measureSync, safeValidateConfig, validateConfig };

package/dist/index.js

@@ -8,9 +8,9 @@ var promises = require('fs/promises');
 var rotatingFileStream = require('rotating-file-stream');
 var events = require('events');
 var clientCloudwatchLogs = require('@aws-sdk/client-cloudwatch-logs');
+var crypto = require('crypto');
 var zod = require('zod');
 var path = require('path');
-var crypto = require('crypto');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
@@ -422,13 +422,50 @@ var TelegramTransport = class extends BaseHttpTransport {
     return text.replace(/[&<>"']/g, (c) => entities[c] || c);
   }
 };
+var instanceUuid = crypto.randomUUID().slice(0, 8);
+function formatDate() {
+  return (/* @__PURE__ */ new Date()).toISOString().slice(0, 10);
+}
+function formatDateTime() {
+  return (/* @__PURE__ */ new Date()).toISOString().slice(0, 19).replace(/[T:]/g, "-");
+}
+function resolveLogStreamName(config, configHostname) {
+  const hostname = configHostname || process.env.HOSTNAME || os.hostname();
+  if (!config) {
+    return hostname;
+  }
+  if (typeof config === "string") {
+    return config;
+  }
+  if ("pattern" in config) {
+    switch (config.pattern) {
+      case "hostname":
+        return hostname;
+      case "hostname-date":
+        return `${hostname}/${formatDate()}`;
+      case "hostname-uuid":
+        return `${hostname}-${instanceUuid}`;
+      case "date":
+        return formatDate();
+      case "uuid":
+        return crypto.randomUUID();
+      default:
+        return hostname;
+    }
+  }
+  if ("template" in config) {
+    return config.template.replace(/\{hostname\}/g, hostname).replace(/\{date\}/g, formatDate()).replace(/\{datetime\}/g, formatDateTime()).replace(/\{uuid\}/g, instanceUuid).replace(/\{pid\}/g, String(process.pid)).replace(/\{env\}/g, process.env.NODE_ENV || "development");
+  }
+  return hostname;
+}
 var CloudWatchTransport = class extends BaseHttpTransport {
   config;
   client;
   sequenceToken;
   initialized = false;
   initPromise = null;
-  constructor(config) {
+  resolvedLogStreamName;
+  constructor(config, configHostname) {
     super({
       batchSize: config.batchSize ?? 100,
       flushInterval: config.flushInterval ?? 1e3,
@@ -436,6 +473,7 @@ var CloudWatchTransport = class extends BaseHttpTransport {
       retryDelay: config.retryDelay
     });
     this.config = config;
+    this.resolvedLogStreamName = resolveLogStreamName(config.logStreamName, configHostname);
     this.client = new clientCloudwatchLogs.CloudWatchLogsClient({
       region: config.region,
       credentials: {
@@ -458,7 +496,7 @@ var CloudWatchTransport = class extends BaseHttpTransport {
     logEvents.sort((a, b) => (a.timestamp ?? 0) - (b.timestamp ?? 0));
     const command = new clientCloudwatchLogs.PutLogEventsCommand({
       logGroupName: this.config.logGroupName,
-      logStreamName: this.config.logStreamName,
+      logStreamName: this.resolvedLogStreamName,
       logEvents,
       sequenceToken: this.sequenceToken
     });
@@ -470,7 +508,7 @@ var CloudWatchTransport = class extends BaseHttpTransport {
         await this.fetchSequenceToken();
         const retryCommand = new clientCloudwatchLogs.PutLogEventsCommand({
           logGroupName: this.config.logGroupName,
-          logStreamName: this.config.logStreamName,
+          logStreamName: this.resolvedLogStreamName,
           logEvents,
           sequenceToken: this.sequenceToken
         });
@@ -516,7 +554,7 @@ var CloudWatchTransport = class extends BaseHttpTransport {
       await this.client.send(
         new clientCloudwatchLogs.CreateLogStreamCommand({
           logGroupName: this.config.logGroupName,
-          logStreamName: this.config.logStreamName
+          logStreamName: this.resolvedLogStreamName
         })
       );
     } catch (error) {
@@ -529,11 +567,11 @@ var CloudWatchTransport = class extends BaseHttpTransport {
     const response = await this.client.send(
       new clientCloudwatchLogs.DescribeLogStreamsCommand({
         logGroupName: this.config.logGroupName,
-        logStreamNamePrefix: this.config.logStreamName,
+        logStreamNamePrefix: this.resolvedLogStreamName,
         limit: 1
       })
     );
-    const stream = response.logStreams?.find((s) => s.logStreamName === this.config.logStreamName);
+    const stream = response.logStreams?.find((s) => s.logStreamName === this.resolvedLogStreamName);
     this.sequenceToken = stream?.uploadSequenceToken;
   }
   isResourceAlreadyExistsError(error) {
@@ -713,7 +751,7 @@ function createStreams(config, store) {
     });
   }
   for (const cloudwatchConfig of toArray(config.cloudwatch)) {
-    const transport = new CloudWatchTransport(cloudwatchConfig);
+    const transport = new CloudWatchTransport(cloudwatchConfig, config.hostname);
     const cwStream = createHttpTransportStream(transport, cloudwatchConfig.level, cloudwatchConfig.rules, store);
     streams.push({
       level: "trace",
@@ -927,6 +965,24 @@ var TelegramConfigSchema = zod.z.object({
   threadId: zod.z.number().int().optional(),
   replyToMessageId: zod.z.number().int().optional()
 });
+var LogStreamPatternSchema = zod.z.enum([
+  "hostname",
+  "hostname-date",
+  "hostname-uuid",
+  "date",
+  "uuid"
+]);
+var LogStreamPatternConfigSchema = zod.z.object({
+  pattern: LogStreamPatternSchema
+});
+var LogStreamTemplateConfigSchema = zod.z.object({
+  template: zod.z.string().min(1, "template is required")
+});
+var LogStreamNameSchema = zod.z.union([
+  zod.z.string().min(1, "logStreamName string must not be empty"),
+  LogStreamPatternConfigSchema,
+  LogStreamTemplateConfigSchema
+]);
 var CloudWatchConfigSchema = zod.z.object({
   level: LogLevelSchema.optional(),
   rules: zod.z.array(LevelRuleSchema).optional(),
@@ -935,7 +991,7 @@ var CloudWatchConfigSchema = zod.z.object({
   maxRetries: zod.z.number().int().nonnegative().optional(),
   retryDelay: zod.z.number().int().positive().optional(),
   logGroupName: zod.z.string().min(1, "logGroupName is required"),
-  logStreamName: zod.z.string().min(1, "logStreamName is required"),
+  logStreamName: LogStreamNameSchema.optional(),
   region: zod.z.string().min(1, "region is required"),
   accessKeyId: zod.z.string().min(1, "accessKeyId is required"),
   secretAccessKey: zod.z.string().min(1, "secretAccessKey is required"),
@@ -1402,6 +1458,10 @@ exports.LevelConfigSchema = LevelConfigSchema;
 exports.LevelRuleSchema = LevelRuleSchema;
 exports.LogFormatSchema = LogFormatSchema;
 exports.LogLevelSchema = LogLevelSchema;
+exports.LogStreamNameSchema = LogStreamNameSchema;
+exports.LogStreamPatternConfigSchema = LogStreamPatternConfigSchema;
+exports.LogStreamPatternSchema = LogStreamPatternSchema;
+exports.LogStreamTemplateConfigSchema = LogStreamTemplateConfigSchema;
 exports.Logger = Logger;
 exports.LoggerConfigSchema = LoggerConfigSchema;
 exports.LoggerStore = LoggerStore;