Skip to content

Commit

Permalink
Remove non-lang excludes and clean up doc guides
Browse files Browse the repository at this point in the history
  • Loading branch information
bryannaegele committed Sep 16, 2024
1 parent 357178d commit 69b41af
Show file tree
Hide file tree
Showing 24 changed files with 3,660 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@

%%%------------------------------------------------------------------------
%% Copyright The OpenTelemetry Authors
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%%-------------------------------------------------------------------------

%% The provenance filename of the built attestation which directly relates to the build artifact filename. This filename SHOULD accompany the artifact at publish time. See the [SLSA Relationship](https://slsa.dev/spec/v1.0/distributing-provenance#relationship-between-artifacts-and-attestations) specification for more information.
%%
-define(ARTIFACT_ATTESTATION_FILENAME, 'artifact.attestation.filename').


%% The full [hash value (see glossary)](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf), of the built attestation. Some envelopes in the software attestation space also refer to this as the [digest](https://github.com/in-toto/attestation/blob/main/spec/README.md#in-toto-attestation-framework-spec).
%%
-define(ARTIFACT_ATTESTATION_HASH, 'artifact.attestation.hash').


%% The id of the build [software attestation](https://slsa.dev/attestation-model).
%%
-define(ARTIFACT_ATTESTATION_ID, 'artifact.attestation.id').


%% The human readable file name of the artifact, typically generated during build and release processes. Often includes the package name and version in the file name.
%%
-define(ARTIFACT_FILENAME, 'artifact.filename').


%% The full [hash value (see glossary)](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf), often found in checksum.txt on a release of the artifact and used to verify package integrity.
%%
-define(ARTIFACT_HASH, 'artifact.hash').


%% The [Package URL](https://github.com/package-url/purl-spec) of the [package artifact](https://slsa.dev/spec/v1.0/terminology#package-model) provides a standard way to identify and locate the packaged artifact.
%%
-define(ARTIFACT_PURL, 'artifact.purl').


%% The version of the artifact.
%%
-define(ARTIFACT_VERSION, 'artifact.version').
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@

%%%------------------------------------------------------------------------
%% Copyright The OpenTelemetry Authors
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%%-------------------------------------------------------------------------

%% The human readable name of the pipeline within a CI/CD system.
%%
-define(CICD_PIPELINE_NAME, 'cicd.pipeline.name').


%% The unique identifier of a pipeline run within a CI/CD system.
%%
-define(CICD_PIPELINE_RUN_ID, 'cicd.pipeline.run.id').


%% The human readable name of a task within a pipeline. Task here most closely aligns with a [computing process](https://en.wikipedia.org/wiki/Pipeline_(computing)) in a pipeline. Other terms for tasks include commands, steps, and procedures.
%%
-define(CICD_PIPELINE_TASK_NAME, 'cicd.pipeline.task.name').


%% The unique identifier of a task run within a pipeline.
%%
-define(CICD_PIPELINE_TASK_RUN_ID, 'cicd.pipeline.task.run.id').


%% The [URL](https://en.wikipedia.org/wiki/URL) of the pipeline run providing the complete address in order to locate and identify the pipeline run.
%%
-define(CICD_PIPELINE_TASK_RUN_URL_FULL, 'cicd.pipeline.task.run.url.full').


%% The type of the task within a pipeline.
%%
-define(CICD_PIPELINE_TASK_TYPE, 'cicd.pipeline.task.type').

-define(CICD_PIPELINE_TASK_TYPE_VALUES_BUILD, 'build').

-define(CICD_PIPELINE_TASK_TYPE_VALUES_TEST, 'test').

-define(CICD_PIPELINE_TASK_TYPE_VALUES_DEPLOY, 'deploy').

Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@

%%%------------------------------------------------------------------------
%% Copyright The OpenTelemetry Authors
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%%-------------------------------------------------------------------------

%% The mode of the CPU
-define(CPU_MODE, 'cpu.mode').

-define(CPU_MODE_VALUES_USER, 'user').

-define(CPU_MODE_VALUES_SYSTEM, 'system').

-define(CPU_MODE_VALUES_NICE, 'nice').

-define(CPU_MODE_VALUES_IDLE, 'idle').

-define(CPU_MODE_VALUES_IOWAIT, 'iowait').

-define(CPU_MODE_VALUES_INTERRUPT, 'interrupt').

-define(CPU_MODE_VALUES_STEAL, 'steal').

-define(CPU_MODE_VALUES_KERNEL, 'kernel').

Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@

%%%------------------------------------------------------------------------
%% Copyright The OpenTelemetry Authors
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%%-------------------------------------------------------------------------

%% A unique identifier representing the device
%%
-define(DEVICE_ID, 'device.id').


%% The name of the device manufacturer
%%
-define(DEVICE_MANUFACTURER, 'device.manufacturer').


%% The model identifier for the device
%%
-define(DEVICE_MODEL_IDENTIFIER, 'device.model.identifier').


%% The marketing name for the device model
%%
-define(DEVICE_MODEL_NAME, 'device.model.name').
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@

%%%------------------------------------------------------------------------
%% Copyright The OpenTelemetry Authors
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%%-------------------------------------------------------------------------

%% The disk IO operation direction.
-define(DISK_IO_DIRECTION, 'disk.io.direction').

-define(DISK_IO_DIRECTION_VALUES_READ, 'read').

-define(DISK_IO_DIRECTION_VALUES_WRITE, 'write').

Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@

%%%------------------------------------------------------------------------
%% Copyright The OpenTelemetry Authors
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%%-------------------------------------------------------------------------

%% The Linux Slab memory state
-define(LINUX_MEMORY_SLAB_STATE, 'linux.memory.slab.state').

-define(LINUX_MEMORY_SLAB_STATE_VALUES_RECLAIMABLE, 'reclaimable').

-define(LINUX_MEMORY_SLAB_STATE_VALUES_UNRECLAIMABLE, 'unreclaimable').

Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@

%%%------------------------------------------------------------------------
%% Copyright The OpenTelemetry Authors
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%%-------------------------------------------------------------------------

%% The logical CPU number [0..n-1]
-define(SYSTEM_CPU_LOGICAL_NUMBER, 'system.cpu.logical_number').

%% @deprecated Replaced by `cpu.mode`
%% Deprecated, use `cpu.mode` instead.
-define(SYSTEM_CPU_STATE, 'system.cpu.state').

-define(SYSTEM_CPU_STATE_VALUES_USER, 'user').

-define(SYSTEM_CPU_STATE_VALUES_SYSTEM, 'system').

-define(SYSTEM_CPU_STATE_VALUES_NICE, 'nice').

-define(SYSTEM_CPU_STATE_VALUES_IDLE, 'idle').

-define(SYSTEM_CPU_STATE_VALUES_IOWAIT, 'iowait').

-define(SYSTEM_CPU_STATE_VALUES_INTERRUPT, 'interrupt').

-define(SYSTEM_CPU_STATE_VALUES_STEAL, 'steal').



%% The device identifier
-define(SYSTEM_DEVICE, 'system.device').


%% The filesystem mode
-define(SYSTEM_FILESYSTEM_MODE, 'system.filesystem.mode').


%% The filesystem mount path
-define(SYSTEM_FILESYSTEM_MOUNTPOINT, 'system.filesystem.mountpoint').


%% The filesystem state
-define(SYSTEM_FILESYSTEM_STATE, 'system.filesystem.state').

-define(SYSTEM_FILESYSTEM_STATE_VALUES_USED, 'used').

-define(SYSTEM_FILESYSTEM_STATE_VALUES_FREE, 'free').

-define(SYSTEM_FILESYSTEM_STATE_VALUES_RESERVED, 'reserved').



%% The filesystem type
-define(SYSTEM_FILESYSTEM_TYPE, 'system.filesystem.type').

-define(SYSTEM_FILESYSTEM_TYPE_VALUES_FAT32, 'fat32').

-define(SYSTEM_FILESYSTEM_TYPE_VALUES_EXFAT, 'exfat').

-define(SYSTEM_FILESYSTEM_TYPE_VALUES_NTFS, 'ntfs').

-define(SYSTEM_FILESYSTEM_TYPE_VALUES_REFS, 'refs').

-define(SYSTEM_FILESYSTEM_TYPE_VALUES_HFSPLUS, 'hfsplus').

-define(SYSTEM_FILESYSTEM_TYPE_VALUES_EXT4, 'ext4').



%% The memory state
-define(SYSTEM_MEMORY_STATE, 'system.memory.state').

-define(SYSTEM_MEMORY_STATE_VALUES_USED, 'used').

-define(SYSTEM_MEMORY_STATE_VALUES_FREE, 'free').

-define(SYSTEM_MEMORY_STATE_VALUES_SHARED, 'shared').

-define(SYSTEM_MEMORY_STATE_VALUES_BUFFERS, 'buffers').

-define(SYSTEM_MEMORY_STATE_VALUES_CACHED, 'cached').



%% A stateless protocol MUST NOT set this attribute
-define(SYSTEM_NETWORK_STATE, 'system.network.state').

-define(SYSTEM_NETWORK_STATE_VALUES_CLOSE, 'close').

-define(SYSTEM_NETWORK_STATE_VALUES_CLOSE_WAIT, 'close_wait').

-define(SYSTEM_NETWORK_STATE_VALUES_CLOSING, 'closing').

-define(SYSTEM_NETWORK_STATE_VALUES_DELETE, 'delete').

-define(SYSTEM_NETWORK_STATE_VALUES_ESTABLISHED, 'established').

-define(SYSTEM_NETWORK_STATE_VALUES_FIN_WAIT_1, 'fin_wait_1').

-define(SYSTEM_NETWORK_STATE_VALUES_FIN_WAIT_2, 'fin_wait_2').

-define(SYSTEM_NETWORK_STATE_VALUES_LAST_ACK, 'last_ack').

-define(SYSTEM_NETWORK_STATE_VALUES_LISTEN, 'listen').

-define(SYSTEM_NETWORK_STATE_VALUES_SYN_RECV, 'syn_recv').

-define(SYSTEM_NETWORK_STATE_VALUES_SYN_SENT, 'syn_sent').

-define(SYSTEM_NETWORK_STATE_VALUES_TIME_WAIT, 'time_wait').



%% The paging access direction
-define(SYSTEM_PAGING_DIRECTION, 'system.paging.direction').

-define(SYSTEM_PAGING_DIRECTION_VALUES_IN, 'in').

-define(SYSTEM_PAGING_DIRECTION_VALUES_OUT, 'out').



%% The memory paging state
-define(SYSTEM_PAGING_STATE, 'system.paging.state').

-define(SYSTEM_PAGING_STATE_VALUES_USED, 'used').

-define(SYSTEM_PAGING_STATE_VALUES_FREE, 'free').



%% The memory paging type
-define(SYSTEM_PAGING_TYPE, 'system.paging.type').

-define(SYSTEM_PAGING_TYPE_VALUES_MAJOR, 'major').

-define(SYSTEM_PAGING_TYPE_VALUES_MINOR, 'minor').



%% The process state, e.g., [Linux Process State Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES)
%%
-define(SYSTEM_PROCESS_STATUS, 'system.process.status').

-define(SYSTEM_PROCESS_STATUS_VALUES_RUNNING, 'running').

-define(SYSTEM_PROCESS_STATUS_VALUES_SLEEPING, 'sleeping').

-define(SYSTEM_PROCESS_STATUS_VALUES_STOPPED, 'stopped').

-define(SYSTEM_PROCESS_STATUS_VALUES_DEFUNCT, 'defunct').


%% @deprecated Replaced by `system.process.status`.
%% Deprecated, use `system.process.status` instead.
-define(SYSTEM_PROCESSES_STATUS, 'system.processes.status').

-define(SYSTEM_PROCESSES_STATUS_VALUES_RUNNING, 'running').

-define(SYSTEM_PROCESSES_STATUS_VALUES_SLEEPING, 'sleeping').

-define(SYSTEM_PROCESSES_STATUS_VALUES_STOPPED, 'stopped').

-define(SYSTEM_PROCESSES_STATUS_VALUES_DEFUNCT, 'defunct').

Loading

0 comments on commit 69b41af

Please sign in to comment.