File: cloud_attributes.h

package info (click to toggle)
opentelemetry-cpp 1.23.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 11,372 kB
  • sloc: cpp: 96,239; sh: 1,766; makefile: 36; python: 31
file content (287 lines) | stat: -rw-r--r-- 8,105 bytes parent folder | download
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
286
287
/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

/*
 * DO NOT EDIT, this is an Auto-generated file from:
 * buildscripts/semantic-convention/templates/registry/semantic_attributes-h.j2
 */

#pragma once

#include "opentelemetry/common/macros.h"
#include "opentelemetry/version.h"

OPENTELEMETRY_BEGIN_NAMESPACE
namespace semconv
{
namespace cloud
{

/**
  The cloud account ID the resource is assigned to.
 */
static constexpr const char *kCloudAccountId = "cloud.account.id";

/**
  Cloud regions often have multiple, isolated locations known as zones to increase availability.
  Availability zone represents the zone where the resource is running. <p> Availability zones are
  called "zones" on Alibaba Cloud and Google Cloud.
 */
static constexpr const char *kCloudAvailabilityZone = "cloud.availability_zone";

/**
  The cloud platform in use.
  <p>
  The prefix of the service SHOULD match the one specified in @code cloud.provider @endcode.
 */
static constexpr const char *kCloudPlatform = "cloud.platform";

/**
  Name of the cloud provider.
 */
static constexpr const char *kCloudProvider = "cloud.provider";

/**
  The geographical region within a cloud provider. When associated with a resource, this attribute
  specifies the region where the resource operates. When calling services or APIs deployed on a
  cloud, this attribute identifies the region where the called destination is deployed. <p> Refer to
  your provider's docs to see the available regions, for example <a
  href="https://www.alibabacloud.com/help/doc-detail/40654.htm">Alibaba Cloud regions</a>, <a
  href="https://aws.amazon.com/about-aws/global-infrastructure/regions_az/">AWS regions</a>, <a
  href="https://azure.microsoft.com/global-infrastructure/geographies/">Azure regions</a>, <a
  href="https://cloud.google.com/about/locations">Google Cloud regions</a>, or <a
  href="https://www.tencentcloud.com/document/product/213/6091">Tencent Cloud regions</a>.
 */
static constexpr const char *kCloudRegion = "cloud.region";

/**
  Cloud provider-specific native identifier of the monitored cloud resource (e.g. an <a
  href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> on AWS,
  a <a href="https://learn.microsoft.com/rest/api/resources/resources/get-by-id">fully qualified
  resource ID</a> on Azure, a <a href="https://google.aip.dev/122#full-resource-names">full resource
  name</a> on GCP) <p> On some cloud providers, it may not be possible to determine the full ID at
  startup, so it may be necessary to set @code cloud.resource_id @endcode as a span attribute
  instead. <p> The exact value to use for @code cloud.resource_id @endcode depends on the cloud
  provider. The following well-known definitions MUST be used if you set this attribute and they
  apply: <ul> <li><strong>AWS Lambda:</strong> The function <a
  href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a>. Take
  care not to use the "invoked ARN" directly but replace any <a
  href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html">alias suffix</a>
  with the resolved function version, as the same runtime instance may be invocable with
  multiple different aliases.</li>
    <li><strong>GCP:</strong> The <a
  href="https://cloud.google.com/iam/docs/full-resource-names">URI of the resource</a></li>
    <li><strong>Azure:</strong> The <a
  href="https://learn.microsoft.com/rest/api/resources/resources/get-by-id">Fully Qualified Resource
  ID</a> of the invoked function, <em>not</em> the function app, having the form
  @code
  /subscriptions/<SUBSCRIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>
  @endcode. This means that a span attribute MUST be used, as an Azure function app can host
  multiple functions that would usually share a TracerProvider.</li>
  </ul>
 */
static constexpr const char *kCloudResourceId = "cloud.resource_id";

namespace CloudPlatformValues
{
/**
  Alibaba Cloud Elastic Compute Service
 */
static constexpr const char *kAlibabaCloudEcs = "alibaba_cloud_ecs";

/**
  Alibaba Cloud Function Compute
 */
static constexpr const char *kAlibabaCloudFc = "alibaba_cloud_fc";

/**
  Red Hat OpenShift on Alibaba Cloud
 */
static constexpr const char *kAlibabaCloudOpenshift = "alibaba_cloud_openshift";

/**
  AWS Elastic Compute Cloud
 */
static constexpr const char *kAwsEc2 = "aws_ec2";

/**
  AWS Elastic Container Service
 */
static constexpr const char *kAwsEcs = "aws_ecs";

/**
  AWS Elastic Kubernetes Service
 */
static constexpr const char *kAwsEks = "aws_eks";

/**
  AWS Lambda
 */
static constexpr const char *kAwsLambda = "aws_lambda";

/**
  AWS Elastic Beanstalk
 */
static constexpr const char *kAwsElasticBeanstalk = "aws_elastic_beanstalk";

/**
  AWS App Runner
 */
static constexpr const char *kAwsAppRunner = "aws_app_runner";

/**
  Red Hat OpenShift on AWS (ROSA)
 */
static constexpr const char *kAwsOpenshift = "aws_openshift";

/**
  Azure Virtual Machines
 */
static constexpr const char *kAzureVm = "azure.vm";

/**
  Azure Container Apps
 */
static constexpr const char *kAzureContainerApps = "azure.container_apps";

/**
  Azure Container Instances
 */
static constexpr const char *kAzureContainerInstances = "azure.container_instances";

/**
  Azure Kubernetes Service
 */
static constexpr const char *kAzureAks = "azure.aks";

/**
  Azure Functions
 */
static constexpr const char *kAzureFunctions = "azure.functions";

/**
  Azure App Service
 */
static constexpr const char *kAzureAppService = "azure.app_service";

/**
  Azure Red Hat OpenShift
 */
static constexpr const char *kAzureOpenshift = "azure.openshift";

/**
  Google Bare Metal Solution (BMS)
 */
static constexpr const char *kGcpBareMetalSolution = "gcp_bare_metal_solution";

/**
  Google Cloud Compute Engine (GCE)
 */
static constexpr const char *kGcpComputeEngine = "gcp_compute_engine";

/**
  Google Cloud Run
 */
static constexpr const char *kGcpCloudRun = "gcp_cloud_run";

/**
  Google Cloud Kubernetes Engine (GKE)
 */
static constexpr const char *kGcpKubernetesEngine = "gcp_kubernetes_engine";

/**
  Google Cloud Functions (GCF)
 */
static constexpr const char *kGcpCloudFunctions = "gcp_cloud_functions";

/**
  Google Cloud App Engine (GAE)
 */
static constexpr const char *kGcpAppEngine = "gcp_app_engine";

/**
  Red Hat OpenShift on Google Cloud
 */
static constexpr const char *kGcpOpenshift = "gcp_openshift";

/**
  Red Hat OpenShift on IBM Cloud
 */
static constexpr const char *kIbmCloudOpenshift = "ibm_cloud_openshift";

/**
  Compute on Oracle Cloud Infrastructure (OCI)
 */
static constexpr const char *kOracleCloudCompute = "oracle_cloud_compute";

/**
  Kubernetes Engine (OKE) on Oracle Cloud Infrastructure (OCI)
 */
static constexpr const char *kOracleCloudOke = "oracle_cloud_oke";

/**
  Tencent Cloud Cloud Virtual Machine (CVM)
 */
static constexpr const char *kTencentCloudCvm = "tencent_cloud_cvm";

/**
  Tencent Cloud Elastic Kubernetes Service (EKS)
 */
static constexpr const char *kTencentCloudEks = "tencent_cloud_eks";

/**
  Tencent Cloud Serverless Cloud Function (SCF)
 */
static constexpr const char *kTencentCloudScf = "tencent_cloud_scf";

}  // namespace CloudPlatformValues

namespace CloudProviderValues
{
/**
  Alibaba Cloud
 */
static constexpr const char *kAlibabaCloud = "alibaba_cloud";

/**
  Amazon Web Services
 */
static constexpr const char *kAws = "aws";

/**
  Microsoft Azure
 */
static constexpr const char *kAzure = "azure";

/**
  Google Cloud Platform
 */
static constexpr const char *kGcp = "gcp";

/**
  Heroku Platform as a Service
 */
static constexpr const char *kHeroku = "heroku";

/**
  IBM Cloud
 */
static constexpr const char *kIbmCloud = "ibm_cloud";

/**
  Oracle Cloud Infrastructure (OCI)
 */
static constexpr const char *kOracleCloud = "oracle_cloud";

/**
  Tencent Cloud
 */
static constexpr const char *kTencentCloud = "tencent_cloud";

}  // namespace CloudProviderValues

}  // namespace cloud
}  // namespace semconv
OPENTELEMETRY_END_NAMESPACE