UNPKG

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