UNPKG

4.63 kBTypeScriptView Raw
1import { DiagLogLevel } from '@opentelemetry/api';
2/**
3 * Environment interface to define all names
4 */
5declare const ENVIRONMENT_BOOLEAN_KEYS: readonly ["OTEL_SDK_DISABLED"];
6declare type ENVIRONMENT_BOOLEANS = {
7 [K in (typeof ENVIRONMENT_BOOLEAN_KEYS)[number]]?: boolean;
8};
9declare const ENVIRONMENT_NUMBERS_KEYS: readonly ["OTEL_BSP_EXPORT_TIMEOUT", "OTEL_BSP_MAX_EXPORT_BATCH_SIZE", "OTEL_BSP_MAX_QUEUE_SIZE", "OTEL_BSP_SCHEDULE_DELAY", "OTEL_BLRP_EXPORT_TIMEOUT", "OTEL_BLRP_MAX_EXPORT_BATCH_SIZE", "OTEL_BLRP_MAX_QUEUE_SIZE", "OTEL_BLRP_SCHEDULE_DELAY", "OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT", "OTEL_ATTRIBUTE_COUNT_LIMIT", "OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT", "OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT", "OTEL_LOGRECORD_ATTRIBUTE_VALUE_LENGTH_LIMIT", "OTEL_LOGRECORD_ATTRIBUTE_COUNT_LIMIT", "OTEL_SPAN_EVENT_COUNT_LIMIT", "OTEL_SPAN_LINK_COUNT_LIMIT", "OTEL_SPAN_ATTRIBUTE_PER_EVENT_COUNT_LIMIT", "OTEL_SPAN_ATTRIBUTE_PER_LINK_COUNT_LIMIT", "OTEL_EXPORTER_OTLP_TIMEOUT", "OTEL_EXPORTER_OTLP_TRACES_TIMEOUT", "OTEL_EXPORTER_OTLP_METRICS_TIMEOUT", "OTEL_EXPORTER_OTLP_LOGS_TIMEOUT", "OTEL_EXPORTER_JAEGER_AGENT_PORT"];
10declare type ENVIRONMENT_NUMBERS = {
11 [K in (typeof ENVIRONMENT_NUMBERS_KEYS)[number]]?: number;
12};
13declare const ENVIRONMENT_LISTS_KEYS: readonly ["OTEL_NO_PATCH_MODULES", "OTEL_PROPAGATORS"];
14declare type ENVIRONMENT_LISTS = {
15 [K in (typeof ENVIRONMENT_LISTS_KEYS)[number]]?: string[];
16};
17export declare type ENVIRONMENT = {
18 CONTAINER_NAME?: string;
19 ECS_CONTAINER_METADATA_URI_V4?: string;
20 ECS_CONTAINER_METADATA_URI?: string;
21 HOSTNAME?: string;
22 KUBERNETES_SERVICE_HOST?: string;
23 NAMESPACE?: string;
24 OTEL_EXPORTER_JAEGER_AGENT_HOST?: string;
25 OTEL_EXPORTER_JAEGER_ENDPOINT?: string;
26 OTEL_EXPORTER_JAEGER_PASSWORD?: string;
27 OTEL_EXPORTER_JAEGER_USER?: string;
28 OTEL_EXPORTER_OTLP_ENDPOINT?: string;
29 OTEL_EXPORTER_OTLP_TRACES_ENDPOINT?: string;
30 OTEL_EXPORTER_OTLP_METRICS_ENDPOINT?: string;
31 OTEL_EXPORTER_OTLP_LOGS_ENDPOINT?: string;
32 OTEL_EXPORTER_OTLP_HEADERS?: string;
33 OTEL_EXPORTER_OTLP_TRACES_HEADERS?: string;
34 OTEL_EXPORTER_OTLP_METRICS_HEADERS?: string;
35 OTEL_EXPORTER_OTLP_LOGS_HEADERS?: string;
36 OTEL_EXPORTER_ZIPKIN_ENDPOINT?: string;
37 OTEL_LOG_LEVEL?: DiagLogLevel;
38 OTEL_RESOURCE_ATTRIBUTES?: string;
39 OTEL_SERVICE_NAME?: string;
40 OTEL_TRACES_EXPORTER?: string;
41 OTEL_TRACES_SAMPLER_ARG?: string;
42 OTEL_TRACES_SAMPLER?: string;
43 OTEL_LOGS_EXPORTER?: string;
44 OTEL_EXPORTER_OTLP_INSECURE?: string;
45 OTEL_EXPORTER_OTLP_TRACES_INSECURE?: string;
46 OTEL_EXPORTER_OTLP_METRICS_INSECURE?: string;
47 OTEL_EXPORTER_OTLP_LOGS_INSECURE?: string;
48 OTEL_EXPORTER_OTLP_CERTIFICATE?: string;
49 OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE?: string;
50 OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE?: string;
51 OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE?: string;
52 OTEL_EXPORTER_OTLP_COMPRESSION?: string;
53 OTEL_EXPORTER_OTLP_TRACES_COMPRESSION?: string;
54 OTEL_EXPORTER_OTLP_METRICS_COMPRESSION?: string;
55 OTEL_EXPORTER_OTLP_LOGS_COMPRESSION?: string;
56 OTEL_EXPORTER_OTLP_CLIENT_KEY?: string;
57 OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY?: string;
58 OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY?: string;
59 OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY?: string;
60 OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE?: string;
61 OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE?: string;
62 OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE?: string;
63 OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE?: string;
64 OTEL_EXPORTER_OTLP_PROTOCOL?: string;
65 OTEL_EXPORTER_OTLP_TRACES_PROTOCOL?: string;
66 OTEL_EXPORTER_OTLP_METRICS_PROTOCOL?: string;
67 OTEL_EXPORTER_OTLP_LOGS_PROTOCOL?: string;
68 OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE?: string;
69} & ENVIRONMENT_BOOLEANS & ENVIRONMENT_NUMBERS & ENVIRONMENT_LISTS;
70export declare type RAW_ENVIRONMENT = {
71 [key: string]: string | number | undefined | string[];
72};
73export declare const DEFAULT_ATTRIBUTE_VALUE_LENGTH_LIMIT: number;
74export declare const DEFAULT_ATTRIBUTE_COUNT_LIMIT = 128;
75export declare const DEFAULT_SPAN_ATTRIBUTE_PER_EVENT_COUNT_LIMIT = 128;
76export declare const DEFAULT_SPAN_ATTRIBUTE_PER_LINK_COUNT_LIMIT = 128;
77/**
78 * Default environment variables
79 */
80export declare const DEFAULT_ENVIRONMENT: Required<ENVIRONMENT>;
81/**
82 * Parses environment values
83 * @param values
84 */
85export declare function parseEnvironment(values: RAW_ENVIRONMENT): ENVIRONMENT;
86/**
87 * Get environment in node or browser without
88 * populating default values.
89 */
90export declare function getEnvWithoutDefaults(): ENVIRONMENT;
91export {};
92//# sourceMappingURL=environment.d.ts.map
\No newline at end of file