Skip to content

Commit

Permalink
removed newer deployment attr so transition to new standard repo is e…
Browse files Browse the repository at this point in the history
…asier
  • Loading branch information
Shane Schisler committed Nov 20, 2024
1 parent 915a8ae commit 7e31493
Show file tree
Hide file tree
Showing 13 changed files with 73 additions and 132 deletions.
1 change: 0 additions & 1 deletion docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ Currently, the following namespaces exist:
- [Cloud](cloud.md)
- [Code](code.md)
- [Contrast](contrast.md)
- [Deployment](deployment.md)
- [Destination](destination.md)
- [Enduser](enduser.md)
- [Error](error.md)
Expand Down
9 changes: 9 additions & 0 deletions docs/attributes-registry/contrast.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
# Contrast

- [Contrast Action Attributes](#contrast-action-attributes)
- [Contrast Host Cmd Exec Attributes](#contrast-host-cmd-exec-attributes)
- [Contrast Resource Attributes](#contrast-resource-attributes)

## Contrast Action Attributes
Expand Down Expand Up @@ -34,6 +35,14 @@ This document defines semantic convention attributes in the Contrast namespace
| `url-forward` | Any function designed to forward a request to another URL | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `url-redirect` | Function that result in an http 302 redirect code sent to the client | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

## Contrast Host Cmd Exec Attributes

Describes attributes for Contrast Action span of type host-cmd-exec.

| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| <a id="contrast-host-cmd-exec-cmd" href="#contrast-host-cmd-exec-cmd">`contrast.host-cmd-exec.cmd`</a> | string | String of executed command with its arguments. | `ls /foo`; `bash -c somebin`; `chmod 755 foobar` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

## Contrast Resource Attributes

contrast defined resources for observability data
Expand Down
33 changes: 0 additions & 33 deletions docs/attributes-registry/deployment.md

This file was deleted.

11 changes: 10 additions & 1 deletion docs/contrast/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,23 @@ action nor will it contain enough information to determine the action execution

**Status:** ![Experimental](https://img.shields.io/badge/-experimental-blue)

**type:** `none`
**type:** `contrast_resource`

**Description:** Additional attributes for Contrast Sensors to provide

| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| [`contrast.semconv.version`](/docs/attributes-registry/contrast.md) | string | The version of contrast semantic conventions that the data adheres to. | `0.1.0` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`otel.semconv.version`](/docs/attributes-registry/contrast.md) | string | The version of otel semantic conventions that the data adheres to. | `1.22.0` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`deployment`](/docs/attributes-registry/contrast.md) | string | deployment environment | `QA`; `DEVELOPMENT`; `PRODUCTION` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

`deployment` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

| Value | Description | Stability |
|---|---|---|
| `DEVELOPMENT` | development environment | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `PRODUCTION` | production environment | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `QA` | quality assurance environment | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
Expand Down
2 changes: 1 addition & 1 deletion docs/contrast/host-cmd-exec.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Used when span name is `host-cmd-exec`.

| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| [`contrast.file.open.path`](/docs/attributes-registry/contrast.md) | string | The absolute path that was accessed. | `/etc/myconfig`; `/foo/bar`; `/some/tmp` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`contrast.host-cmd-exec.cmd`](/docs/attributes-registry/contrast.md) | string | String of executed command with its arguments. | `ls /foo`; `bash -c somebin`; `chmod 755 foobar` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
Expand Down
15 changes: 12 additions & 3 deletions docs/resource/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,14 +235,23 @@ a string starting with `opentelemetry-`, e.g. `opentelemetry-java-instrumentatio

**Status:** ![Experimental](https://img.shields.io/badge/-experimental-blue)

**type:** `none`
**type:** `contrast_resource`

**Description:** Additional attributes for Contrast Sensors to provide

| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| [`contrast.semconv.version`](/docs/attributes-registry/contrast.md) | string | The version of contrast semantic conventions that the data adheres to. | `0.1.0` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`otel.semconv.version`](/docs/attributes-registry/contrast.md) | string | The version of otel semantic conventions that the data adheres to. | `1.22.0` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`deployment`](/docs/attributes-registry/contrast.md) | string | deployment environment | `QA`; `DEVELOPMENT`; `PRODUCTION` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

`deployment` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

| Value | Description | Stability |
|---|---|---|
| `DEVELOPMENT` | development environment | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `PRODUCTION` | production environment | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `QA` | quality assurance environment | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
Expand Down Expand Up @@ -274,8 +283,8 @@ Attributes defining a running environment (e.g. Operating System, Cloud, Data Ce

- [Operating System](./os.md)
- [Cloud](./cloud.md)
- Deployment:
- [Deployment Environment](./deployment-environment.md)
- Contrast Resources:
- [Deployment Environment](./contrast-resources.md)
- [Browser](./browser.md)

## Version attributes
Expand Down
34 changes: 34 additions & 0 deletions docs/resource/contrast-resources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contrast Resource data

<!-- semconv contrast.resource -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
<!-- markdownlint-capture -->
<!-- markdownlint-disable -->


**Status:** ![Experimental](https://img.shields.io/badge/-experimental-blue)

**type:** `contrast_resource`

**Description:** Additional attributes for Contrast Sensors to provide

| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| [`contrast.semconv.version`](/docs/attributes-registry/contrast.md) | string | The version of contrast semantic conventions that the data adheres to. | `0.1.0` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`otel.semconv.version`](/docs/attributes-registry/contrast.md) | string | The version of otel semantic conventions that the data adheres to. | `1.22.0` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`deployment`](/docs/attributes-registry/contrast.md) | string | deployment environment | `QA`; `DEVELOPMENT`; `PRODUCTION` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

`deployment` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

| Value | Description | Stability |
|---|---|---|
| `DEVELOPMENT` | development environment | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `PRODUCTION` | production environment | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `QA` | quality assurance environment | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->
32 changes: 0 additions & 32 deletions docs/resource/deployment-environment.md

This file was deleted.

4 changes: 2 additions & 2 deletions model/contrast/registry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -257,12 +257,12 @@ groups:
value: o_rdwr
brief: Read/write access

- id: contrast.host-cmd-exec
- id: registry.contrast.host-cmd-exec
type: attribute_group
brief: >
Describes attributes for Contrast Action span of type host-cmd-exec.
attributes:
- id: cmd
- id: contrast.host-cmd-exec.cmd
stability: experimental
brief: >
String of executed command with its arguments.
Expand Down
3 changes: 3 additions & 0 deletions model/contrast/resources.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
groups:
- id: contrast.resource
type: resource
name: contrast_resource
brief: >
Additional attributes for Contrast Sensors to provide
attributes:
- ref: contrast.semconv.version
requirement_level: required
- ref: otel.semconv.version
requirement_level: required
- ref: deployment
requirement_level: recommended
4 changes: 2 additions & 2 deletions model/contrast/spans.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ groups:
brief: >
Describes attributes for Contrast Action span of type host-cmd-exec.
attributes:
- ref: contrast.file.open.path
#- ref: contrast.host-cmd-exec.cmd
- ref: contrast.host-cmd-exec.cmd
requirement_level: recommended

- id: span.contrast.action.outbound-service-call
type: span
Expand Down
48 changes: 0 additions & 48 deletions model/deployment/registry.yaml

This file was deleted.

9 changes: 0 additions & 9 deletions model/deployment/resources.yaml

This file was deleted.

0 comments on commit 7e31493

Please sign in to comment.