@oas-tools/oas-telemetry 0.7.0-alpha.2 → 0.7.0-alpha.4

package/.env.example

@@ -1,26 +1,59 @@
-# All environment variables are OPTIONAL, defaults are provided below
+# All environment variables are OPTIONAL
 
-
-# DEVELOPMENT ----------------------------------------------------------
-# This is JUST for development purposes, to test the react app
+# BOOT CONFIGURATION ---------------------------------------------------
+# These variables are used at the import of the library.
 # ----------------------------------------------------------------------
 
-# production, development
-OASTLM_ENV=production
+# Environment mode | Possible values: "production", "development", "test" | Default: "production"
+OASTLM_BOOT_ENV=
+# Disable the module | Possible values: "true", "false" | Default: "false"
+OASTLM_BOOT_MODULE_DISABLED=
+# Logging level for the boot process | Possible values: "DEBUG", "INFO", "WARNING", "ERROR", "NONE" | Default: "INFO"
+OASTLM_BOOT_LOG_LEVEL=
 
 
-# PRODUCTION -----------------------------------------------------------
-# This variables can be configured in the .env file of the project importing our library
+# CONFIGURATION --------------------------------------------------------
+# These variables are used to override the configuration when oasTelemetry(config) is called.
 # ----------------------------------------------------------------------
 
-# Disable the module, no Telemetry collected, empty middleware exported
-OASTLM_MODULE_DISABLED=false
+# Base URL for telemetry | Default: "/telemetry"
+OASTLM_CONFIG_GENERAL_BASE_URL=
+# Specification file name | Default: null
+OASTLM_CONFIG_GENERAL_SPEC_FILE_NAME=
+
+
+# Enable authentication | Possible values: "true", "false" | Default: "false"
+OASTLM_CONFIG_AUTH_ENABLED=
+# Maximum age for API keys (ms) | Default: 3600000 (1 hour)
+OASTLM_CONFIG_AUTH_API_KEY_MAX_AGE=
+# Password for authentication | Default: "oas-telemetry-password"
+OASTLM_CONFIG_AUTH_PASSWORD=
+# JWT secret for authentication | Default: "oas-telemetry-secret"
+OASTLM_CONFIG_AUTH_JWT_SECRET=
+
+
+# Enable memory exporter for traces | Possible values: "true", "false" | Default: "true"
+OASTLM_CONFIG_TRACES_MEMORY_EXPORTER_ENABLED=
+# Retention time for memory exporter (s) | Default: 3600 (1 hour)
+OASTLM_CONFIG_TRACES_MEMORY_EXPORTER_RETENTION_TIME_SECONDS=
+
+
+# Export interval for main metric reader (ms) | Default: 60000 (60 seconds)
+OASTLM_CONFIG_METRICS_MAIN_READER_EXPORT_INTERVAL=
+# Enable memory exporter for metrics | Possible values: "true", "false" | Default: "true"
+OASTLM_CONFIG_METRICS_MEMORY_EXPORTER_ENABLED=
+# Retention time for memory exporter (s) | Default: 3600 (1 hour)
+OASTLM_CONFIG_METRICS_MEMORY_EXPORTER_RETENTION_TIME_SECONDS=
+
 
-OASTLM_AI_OPENAI_API_KEY=
-OASTLM_AI_OPENAI_MODEL_NAME=gpt-4o-mini
+# Enable memory exporter for logs | Possible values: "true", "false" | Default: "true"
+OASTLM_CONFIG_LOGS_MEMORY_EXPORTER_ENABLED=
+# Retention time for memory exporter (s) | Default: 3600 (1 hour)
+OASTLM_CONFIG_LOGS_MEMORY_EXPORTER_RETENTION_TIME_SECONDS=
 
-# Used in OASTLM logger
-OASTLM_SERVICE_NAME=OAS-TLM
-# LEVELS: DEBUG, INFO, WARNING, ERROR, NONE
-# Note: "NONE" will disable all OASTLM logging
-OASTLM_LOG_LEVEL=INFO
+# OpenAI API key | Default: null
+OASTLM_CONFIG_AI_OPENAI_KEY=
+# OpenAI model name | Default: "gpt-3.5-turbo"
+OASTLM_CONFIG_AI_OPENAI_MODEL=
+# Extra context prompts for AI | Default: empty (e.g., "Prompt1,Prompt2")
+OASTLM_CONFIG_AI_EXTRA_CONTEXT_PROMPTS=