1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
#include "opentelemetry/sdk/common/env_variables.h"
#ifdef _MSC_VER
# include <string.h>
# define strcasecmp _stricmp
#else
# include <strings.h>
#endif
#include <cctype>
#include <cerrno>
#include <cstdlib>
#include <limits>
#include <ostream>
#include "opentelemetry/nostd/string_view.h"
#include "opentelemetry/sdk/common/global_log_handler.h"
#include "opentelemetry/version.h"
OPENTELEMETRY_BEGIN_NAMESPACE
namespace sdk
{
namespace common
{
static bool GetRawEnvironmentVariable(const char *env_var_name, std::string &value)
{
#if !defined(NO_GETENV)
const char *endpoint_from_env = nullptr;
# if defined(_MSC_VER)
// avoid calling std::getenv which is deprecated in MSVC.
size_t required_size = 0;
getenv_s(&required_size, nullptr, 0, env_var_name);
std::unique_ptr<char[]> endpoint_buffer;
if (required_size > 0)
{
endpoint_buffer = std::unique_ptr<char[]>{new char[required_size]};
getenv_s(&required_size, endpoint_buffer.get(), required_size, env_var_name);
endpoint_from_env = endpoint_buffer.get();
}
# else
endpoint_from_env = std::getenv(env_var_name);
# endif // defined(_MSC_VER)
if (endpoint_from_env != nullptr)
{
value = std::string{endpoint_from_env};
return true;
}
value = std::string{};
return false;
#else
value = std::string{};
return false;
#endif // !defined(NO_GETENV)
}
bool GetBoolEnvironmentVariable(const char *env_var_name, bool &value)
{
std::string raw_value;
bool exists = GetRawEnvironmentVariable(env_var_name, raw_value);
if (!exists || raw_value.empty())
{
value = false;
return false;
}
if (strcasecmp(raw_value.c_str(), "true") == 0)
{
value = true;
return true;
}
if (strcasecmp(raw_value.c_str(), "false") == 0)
{
value = false;
return true;
}
OTEL_INTERNAL_LOG_WARN("Environment variable <" << env_var_name << "> has an invalid value <"
<< raw_value << ">, defaulting to false");
value = false;
return true;
}
static bool GetTimeoutFromString(const char *input, std::chrono::system_clock::duration &value)
{
std::chrono::system_clock::duration::rep result = 0;
// Skip spaces
for (; *input && std::isspace(*input); ++input)
;
for (; *input && std::isdigit(*input); ++input)
{
auto digit = (*input - '0');
if (result > (std::numeric_limits<decltype(result)>::max() - digit) / 10)
{
// Rejecting overflow as invalid.
return false;
}
result = result * 10 + digit;
}
if (result == 0)
{
// Rejecting duration 0 as invalid.
return false;
}
opentelemetry::nostd::string_view unit{input};
if (unit == "ns")
{
value = std::chrono::duration_cast<std::chrono::system_clock::duration>(
std::chrono::nanoseconds{result});
return true;
}
if (unit == "us")
{
value = std::chrono::duration_cast<std::chrono::system_clock::duration>(
std::chrono::microseconds{result});
return true;
}
if (unit == "ms")
{
value = std::chrono::duration_cast<std::chrono::system_clock::duration>(
std::chrono::milliseconds{result});
return true;
}
if (unit == "s")
{
value = std::chrono::duration_cast<std::chrono::system_clock::duration>(
std::chrono::seconds{result});
return true;
}
if (unit == "m")
{
value = std::chrono::duration_cast<std::chrono::system_clock::duration>(
std::chrono::minutes{result});
return true;
}
if (unit == "h")
{
value =
std::chrono::duration_cast<std::chrono::system_clock::duration>(std::chrono::hours{result});
return true;
}
if (unit == "")
{
// The spec says milliseconds, but opentelemetry-cpp implemented
// seconds by default, up to opentelemetry-cpp 1.26.0.
value = std::chrono::duration_cast<std::chrono::system_clock::duration>(
std::chrono::milliseconds{result});
return true;
}
// Failed to parse the input string.
return false;
}
bool GetDurationEnvironmentVariable(const char *env_var_name,
std::chrono::system_clock::duration &value)
{
std::string raw_value;
bool exists = GetRawEnvironmentVariable(env_var_name, raw_value);
if (!exists || raw_value.empty())
{
value =
std::chrono::duration_cast<std::chrono::system_clock::duration>(std::chrono::seconds{0});
return false;
}
exists = GetTimeoutFromString(raw_value.c_str(), value);
if (!exists)
{
OTEL_INTERNAL_LOG_WARN("Environment variable <" << env_var_name << "> has an invalid value <"
<< raw_value << ">, ignoring");
}
return exists;
}
bool GetStringEnvironmentVariable(const char *env_var_name, std::string &value)
{
bool exists = GetRawEnvironmentVariable(env_var_name, value);
if (!exists || value.empty())
{
return false;
}
return true;
}
bool GetUintEnvironmentVariable(const char *env_var_name, std::uint32_t &value)
{
static constexpr auto kDefaultValue = 0U;
std::string raw_value;
bool exists = GetRawEnvironmentVariable(env_var_name, raw_value);
if (!exists || raw_value.empty())
{
value = kDefaultValue;
return false;
}
const char *end = raw_value.c_str() + raw_value.length();
char *actual_end = nullptr;
const auto temp = std::strtoull(raw_value.c_str(), &actual_end, 10);
if (errno == ERANGE)
{
errno = 0;
OTEL_INTERNAL_LOG_WARN("Environment variable <" << env_var_name << "> is out of range <"
<< raw_value << ">, defaulting to "
<< kDefaultValue);
}
else if (actual_end != end || std::numeric_limits<std::uint32_t>::max() < temp)
{
OTEL_INTERNAL_LOG_WARN("Environment variable <" << env_var_name << "> has an invalid value <"
<< raw_value << ">, defaulting to "
<< kDefaultValue);
}
else
{
value = static_cast<std::uint32_t>(temp);
return true;
}
value = kDefaultValue;
return false;
}
bool GetFloatEnvironmentVariable(const char *env_var_name, float &value)
{
static constexpr auto kDefaultValue = 0.0f;
std::string raw_value;
bool exists = GetRawEnvironmentVariable(env_var_name, raw_value);
if (!exists || raw_value.empty())
{
value = kDefaultValue;
return false;
}
const char *end = raw_value.c_str() + raw_value.length();
char *actual_end = nullptr;
value = std::strtof(raw_value.c_str(), &actual_end);
if (errno == ERANGE)
{
errno = 0;
OTEL_INTERNAL_LOG_WARN("Environment variable <" << env_var_name << "> is out of range <"
<< raw_value << ">, defaulting to "
<< kDefaultValue);
}
else if (actual_end != end)
{
OTEL_INTERNAL_LOG_WARN("Environment variable <" << env_var_name << "> has an invalid value <"
<< raw_value << ">, defaulting to "
<< kDefaultValue);
}
else
{
return true;
}
value = kDefaultValue;
return false;
}
} // namespace common
} // namespace sdk
OPENTELEMETRY_END_NAMESPACE
|
