Skip to content

Commit c85c409

Browse files
authored
Autogenerate semantic convention constants (#1759)
1 parent 6bd163f commit c85c409

File tree

21 files changed

+1893
-58
lines changed

21 files changed

+1893
-58
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ env:
1010
# Otherwise, set variable to the commit of your branch on
1111
# opentelemetry-python-contrib which is compatible with these Core repo
1212
# changes.
13-
CONTRIB_REPO_SHA: 1064da4bf2afaa0fb84fa10f573b211efeba72bc
13+
CONTRIB_REPO_SHA: 2cfa00e1f9277fcefdb64a8f47e7a99681ab65fa
1414

1515
jobs:
1616
build:

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
- Added `py.typed` file to every package. This should resolve a bunch of mypy
1111
errors for users.
1212
([#1720](https://github.com/open-telemetry/opentelemetry-python/pull/1720))
13+
- Add auto generated trace and resource attributes semantic conventions
14+
([#1759](https://github.com/open-telemetry/opentelemetry-python/pull/1759))
1315
- Added `SpanKind` to `should_sample` parameters, suggest using parent span context's tracestate
1416
instead of manually passed in tracestate in `should_sample`
1517
([#1764](https://github.com/open-telemetry/opentelemetry-python/pull/1764))

docs-requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ sphinx-autodoc-typehints
55
# Need to install the api/sdk in the venv for autodoc. Modifying sys.path
66
# doesn't work for pkg_resources.
77
./opentelemetry-api
8+
./opentelemetry-semantic-conventions
89
./opentelemetry-sdk
910
./opentelemetry-instrumentation
1011

opentelemetry-sdk/setup.cfg

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ zip_safe = False
4242
include_package_data = True
4343
install_requires =
4444
opentelemetry-api == 1.0.1.dev0
45+
opentelemetry-semantic-conventions == 0.20.dev0
4546

4647
[options.packages.find]
4748
where = src

opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py

Lines changed: 56 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -65,67 +65,68 @@
6565
import pkg_resources
6666

6767
from opentelemetry.sdk.environment_variables import OTEL_RESOURCE_ATTRIBUTES
68+
from opentelemetry.semconv.resource import ResourceAttributes
6869

6970
LabelValue = typing.Union[str, bool, int, float]
7071
Attributes = typing.Dict[str, LabelValue]
7172
logger = logging.getLogger(__name__)
7273

7374

74-
CLOUD_PROVIDER = "cloud.provider"
75-
CLOUD_ACCOUNT_ID = "cloud.account.id"
76-
CLOUD_REGION = "cloud.region"
77-
CLOUD_ZONE = "cloud.zone"
78-
CONTAINER_NAME = "container.name"
79-
CONTAINER_ID = "container.id"
80-
CONTAINER_IMAGE_NAME = "container.image.name"
81-
CONTAINER_IMAGE_TAG = "container.image.tag"
82-
DEPLOYMENT_ENVIRONMENT = "deployment.environment"
83-
FAAS_NAME = "faas.name"
84-
FAAS_ID = "faas.id"
85-
FAAS_VERSION = "faas.version"
86-
FAAS_INSTANCE = "faas.instance"
87-
HOST_NAME = "host.name"
88-
HOST_TYPE = "host.type"
89-
HOST_IMAGE_NAME = "host.image.name"
90-
HOST_IMAGE_ID = "host.image.id"
91-
HOST_IMAGE_VERSION = "host.image.version"
92-
KUBERNETES_CLUSTER_NAME = "k8s.cluster.name"
93-
KUBERNETES_NAMESPACE_NAME = "k8s.namespace.name"
94-
KUBERNETES_POD_UID = "k8s.pod.uid"
95-
KUBERNETES_POD_NAME = "k8s.pod.name"
96-
KUBERNETES_CONTAINER_NAME = "k8s.container.name"
97-
KUBERNETES_REPLICA_SET_UID = "k8s.replicaset.uid"
98-
KUBERNETES_REPLICA_SET_NAME = "k8s.replicaset.name"
99-
KUBERNETES_DEPLOYMENT_UID = "k8s.deployment.uid"
100-
KUBERNETES_DEPLOYMENT_NAME = "k8s.deployment.name"
101-
KUBERNETES_STATEFUL_SET_UID = "k8s.statefulset.uid"
102-
KUBERNETES_STATEFUL_SET_NAME = "k8s.statefulset.name"
103-
KUBERNETES_DAEMON_SET_UID = "k8s.daemonset.uid"
104-
KUBERNETES_DAEMON_SET_NAME = "k8s.daemonset.name"
105-
KUBERNETES_JOB_UID = "k8s.job.uid"
106-
KUBERNETES_JOB_NAME = "k8s.job.name"
107-
KUBERNETES_CRON_JOB_UID = "k8s.cronjob.uid"
108-
KUBERNETES_CRON_JOB_NAME = "k8s.cronjob.name"
109-
OS_TYPE = "os.type"
110-
OS_DESCRIPTION = "os.description"
111-
PROCESS_PID = "process.pid"
112-
PROCESS_EXECUTABLE_NAME = "process.executable.name"
113-
PROCESS_EXECUTABLE_PATH = "process.executable.path"
114-
PROCESS_COMMAND = "process.command"
115-
PROCESS_COMMAND_LINE = "process.command_line"
116-
PROCESS_COMMAND_ARGS = "process.command_args"
117-
PROCESS_OWNER = "process.owner"
118-
PROCESS_RUNTIME_NAME = "process.runtime.name"
119-
PROCESS_RUNTIME_VERSION = "process.runtime.version"
120-
PROCESS_RUNTIME_DESCRIPTION = "process.runtime.description"
121-
SERVICE_NAME = "service.name"
122-
SERVICE_NAMESPACE = "service.namespace"
123-
SERVICE_INSTANCE_ID = "service.instance.id"
124-
SERVICE_VERSION = "service.version"
125-
TELEMETRY_SDK_NAME = "telemetry.sdk.name"
126-
TELEMETRY_SDK_VERSION = "telemetry.sdk.version"
127-
TELEMETRY_AUTO_VERSION = "telemetry.auto.version"
128-
TELEMETRY_SDK_LANGUAGE = "telemetry.sdk.language"
75+
CLOUD_PROVIDER = ResourceAttributes.CLOUD_PROVIDER
76+
CLOUD_ACCOUNT_ID = ResourceAttributes.CLOUD_ACCOUNT_ID
77+
CLOUD_REGION = ResourceAttributes.CLOUD_REGION
78+
CLOUD_AVAILABILITY_ZONE = ResourceAttributes.CLOUD_AVAILABILITY_ZONE
79+
CONTAINER_NAME = ResourceAttributes.CONTAINER_NAME
80+
CONTAINER_ID = ResourceAttributes.CONTAINER_ID
81+
CONTAINER_IMAGE_NAME = ResourceAttributes.CONTAINER_IMAGE_NAME
82+
CONTAINER_IMAGE_TAG = ResourceAttributes.CONTAINER_IMAGE_TAG
83+
DEPLOYMENT_ENVIRONMENT = ResourceAttributes.DEPLOYMENT_ENVIRONMENT
84+
FAAS_NAME = ResourceAttributes.FAAS_NAME
85+
FAAS_ID = ResourceAttributes.FAAS_ID
86+
FAAS_VERSION = ResourceAttributes.FAAS_VERSION
87+
FAAS_INSTANCE = ResourceAttributes.FAAS_INSTANCE
88+
HOST_NAME = ResourceAttributes.HOST_NAME
89+
HOST_TYPE = ResourceAttributes.HOST_TYPE
90+
HOST_IMAGE_NAME = ResourceAttributes.HOST_IMAGE_NAME
91+
HOST_IMAGE_ID = ResourceAttributes.HOST_IMAGE_ID
92+
HOST_IMAGE_VERSION = ResourceAttributes.HOST_IMAGE_VERSION
93+
KUBERNETES_CLUSTER_NAME = ResourceAttributes.K8S_CLUSTER_NAME
94+
KUBERNETES_NAMESPACE_NAME = ResourceAttributes.K8S_NAMESPACE_NAME
95+
KUBERNETES_POD_UID = ResourceAttributes.K8S_POD_UID
96+
KUBERNETES_POD_NAME = ResourceAttributes.K8S_POD_NAME
97+
KUBERNETES_CONTAINER_NAME = ResourceAttributes.K8S_CONTAINER_NAME
98+
KUBERNETES_REPLICA_SET_UID = ResourceAttributes.K8S_REPLICASET_UID
99+
KUBERNETES_REPLICA_SET_NAME = ResourceAttributes.K8S_REPLICASET_NAME
100+
KUBERNETES_DEPLOYMENT_UID = ResourceAttributes.K8S_DEPLOYMENT_UID
101+
KUBERNETES_DEPLOYMENT_NAME = ResourceAttributes.K8S_DEPLOYMENT_NAME
102+
KUBERNETES_STATEFUL_SET_UID = ResourceAttributes.K8S_STATEFULSET_UID
103+
KUBERNETES_STATEFUL_SET_NAME = ResourceAttributes.K8S_STATEFULSET_NAME
104+
KUBERNETES_DAEMON_SET_UID = ResourceAttributes.K8S_DAEMONSET_UID
105+
KUBERNETES_DAEMON_SET_NAME = ResourceAttributes.K8S_DAEMONSET_NAME
106+
KUBERNETES_JOB_UID = ResourceAttributes.K8S_JOB_UID
107+
KUBERNETES_JOB_NAME = ResourceAttributes.K8S_JOB_NAME
108+
KUBERNETES_CRON_JOB_UID = ResourceAttributes.K8S_CRONJOB_UID
109+
KUBERNETES_CRON_JOB_NAME = ResourceAttributes.K8S_CRONJOB_NAME
110+
OS_TYPE = ResourceAttributes.OS_TYPE
111+
OS_DESCRIPTION = ResourceAttributes.OS_DESCRIPTION
112+
PROCESS_PID = ResourceAttributes.PROCESS_PID
113+
PROCESS_EXECUTABLE_NAME = ResourceAttributes.PROCESS_EXECUTABLE_NAME
114+
PROCESS_EXECUTABLE_PATH = ResourceAttributes.PROCESS_EXECUTABLE_PATH
115+
PROCESS_COMMAND = ResourceAttributes.PROCESS_COMMAND
116+
PROCESS_COMMAND_LINE = ResourceAttributes.PROCESS_COMMAND_LINE
117+
PROCESS_COMMAND_ARGS = ResourceAttributes.PROCESS_COMMAND_ARGS
118+
PROCESS_OWNER = ResourceAttributes.PROCESS_OWNER
119+
PROCESS_RUNTIME_NAME = ResourceAttributes.PROCESS_RUNTIME_NAME
120+
PROCESS_RUNTIME_VERSION = ResourceAttributes.PROCESS_RUNTIME_VERSION
121+
PROCESS_RUNTIME_DESCRIPTION = ResourceAttributes.PROCESS_RUNTIME_DESCRIPTION
122+
SERVICE_NAME = ResourceAttributes.SERVICE_NAME
123+
SERVICE_NAMESPACE = ResourceAttributes.SERVICE_NAMESPACE
124+
SERVICE_INSTANCE_ID = ResourceAttributes.SERVICE_INSTANCE_ID
125+
SERVICE_VERSION = ResourceAttributes.SERVICE_VERSION
126+
TELEMETRY_SDK_NAME = ResourceAttributes.TELEMETRY_SDK_NAME
127+
TELEMETRY_SDK_VERSION = ResourceAttributes.TELEMETRY_SDK_VERSION
128+
TELEMETRY_AUTO_VERSION = ResourceAttributes.TELEMETRY_AUTO_VERSION
129+
TELEMETRY_SDK_LANGUAGE = ResourceAttributes.TELEMETRY_SDK_LANGUAGE
129130

130131

131132
_OPENTELEMETRY_SDK_VERSION = pkg_resources.get_distribution(
Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
graft src
2+
graft tests
3+
global-exclude *.pyc
4+
global-exclude *.pyo
5+
global-exclude __pycache__/*
6+
include CHANGELOG.md
7+
include MANIFEST.in
8+
include README.rst
9+
include LICENSE

0 commit comments

Comments
 (0)