Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Put hiatus on semantic conventions until they are in the new repository. #3489

Merged
merged 9 commits into from
May 11, 2023
5 changes: 5 additions & 0 deletions specification/logs/semantic_conventions/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Log Attribute Semantic Conventions

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.
carlosalberto marked this conversation as resolved.
Show resolved Hide resolved

**Status**: [Experimental](../../document-status.md)

The following semantic conventions for logs are defined:
Expand Down
5 changes: 5 additions & 0 deletions specification/logs/semantic_conventions/events.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Semantic Convention for event attributes

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../document-status.md)

This document describes the attributes of standalone Events that are represented
Expand Down
5 changes: 5 additions & 0 deletions specification/logs/semantic_conventions/exceptions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Semantic Conventions for Exceptions

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../document-status.md)

This document defines semantic conventions for recording exceptions on
Expand Down
5 changes: 5 additions & 0 deletions specification/logs/semantic_conventions/feature-flags.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Semantic Conventions for Feature Flag Evaluations

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../document-status.md)

This document defines semantic conventions for recording feature flag evaluations as
Expand Down
5 changes: 5 additions & 0 deletions specification/logs/semantic_conventions/general.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# General attributes

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../document-status.md)

The attributes described in this section are rather generic.
Expand Down
5 changes: 5 additions & 0 deletions specification/logs/semantic_conventions/media.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Semantic Conventions for Log Media

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../document-status.md)

This document describes attributes for log media in OpenTelemetry. Log media are mechanisms by which logs are transmitted. Types of media include files, streams, network protocols, and os-specific logging services such as journald and Windows Event Log.
Expand Down
5 changes: 5 additions & 0 deletions specification/metrics/semantic_conventions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ linkTitle: Semantic Conventions
<!-- omit in toc -->
# Metrics Semantic Conventions

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Mixed](../../document-status.md)

<!-- toc -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ linkTitle: Database

# Semantic Conventions for Database Metrics

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../document-status.md)

The conventions described in this section are specific to SQL and NoSQL clients.
Expand Down
5 changes: 5 additions & 0 deletions specification/metrics/semantic_conventions/faas-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ linkTitle: FaaS

# Semantic Conventions for FaaS Metrics

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../document-status.md)

This document defines how to describe an instance of a function that runs without provisioning
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ linkTitle: Hardware

# Semantic Conventions for Hardware Metrics

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../document-status.md)

This document describes instruments and attributes for common hardware level
Expand Down
5 changes: 5 additions & 0 deletions specification/metrics/semantic_conventions/http-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ linkTitle: HTTP

# Semantic Conventions for HTTP Metrics

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../document-status.md)

The conventions described in this section are HTTP specific. When HTTP operations occur,
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
# Instrumentation

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ linkTitle: Kafka

# Instrumenting Kafka

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../../document-status.md)

This document defines how to apply semantic conventions when instrumenting Kafka.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ linkTitle: Process

# Semantic Conventions for OS Process Metrics

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../document-status.md)

This document describes instruments and attributes for common OS process level
Expand Down
5 changes: 5 additions & 0 deletions specification/metrics/semantic_conventions/rpc-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ linkTitle: RPC

# General RPC conventions

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../document-status.md)

The conventions described in this section are RPC specific. When RPC operations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ linkTitle: Runtime Environment

# Semantic Conventions for Runtime Environment Metrics

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../document-status.md)

This document includes semantic conventions for runtime environment level
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ linkTitle: System

# Semantic Conventions for System Metrics

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../document-status.md)

This document describes instruments and attributes for common system level
Expand Down
7 changes: 4 additions & 3 deletions specification/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,7 @@ Application owners use the SDK constructors; [plugin authors](glossary.md#plugin

The **Semantic Conventions** define the keys and values which describe commonly observed concepts, protocols, and operations used by applications.

* [Resource Conventions](resource/semantic_conventions/README.md)
* [Span Conventions](trace/semantic_conventions/README.md)
* [Metrics Conventions](metrics/semantic_conventions/README.md)
**Note: Semantic conventions will be moving to a new repository.**
jsuereth marked this conversation as resolved.
Show resolved Hide resolved

Both the collector and the client libraries SHOULD autogenerate semantic
convention keys and enum values into constants (or language idiomatic
Expand All @@ -85,6 +83,9 @@ source of truth for generation. Each language implementation SHOULD
provide language-specific support to the
[code generator](https://github.com/open-telemetry/build-tools/tree/main/semantic-conventions#code-generator).

Additionally, attributes required by the specification will be listed
[here](semantic-conventions.md)

### Contrib Packages

The OpenTelemetry project maintains integrations with popular OSS projects which have been identified as important for observing modern web services.
Expand Down
5 changes: 5 additions & 0 deletions specification/resource/semantic_conventions/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Resource Semantic Conventions

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Mixed](../../document-status.md)

This document defines standard attributes for resources. These attributes are typically used in the [Resource](../sdk.md) and are also recommended to be used anywhere else where there is a need to describe a resource in a consistent manner. The majority of these attributes are inherited from
Expand Down
5 changes: 5 additions & 0 deletions specification/resource/semantic_conventions/browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

**Status**: [Experimental](../../document-status.md)

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**type:** `browser`

**Description**: The web browser in which the application represented by the resource is running. The `browser.*` attributes MUST be used only for resources that represent applications running in a web browser (regardless of whether running on a mobile or desktop device).
Expand Down
5 changes: 5 additions & 0 deletions specification/resource/semantic_conventions/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

**Status**: [Experimental](../../document-status.md)

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**type:** `cloud`

**Description:** A cloud infrastructure (e.g. GCP, Azure, AWS).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# AWS Semantic Conventions

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../../../document-status.md)

This directory defines standards for resource attributes that only apply to Amazon
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# AWS ECS

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../../../document-status.md)

**type:** `aws.ecs`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# AWS EKS

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../../../document-status.md)

**type:** `aws.eks`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# AWS Logs

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**Status**: [Experimental](../../../../document-status.md)

**Type:** `aws.log`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# GCP Semantic Conventions

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

This directory defines standards for resource attributes that only apply to
Google Cloud Platform (GCP). If an attribute could apply to resources from more than one cloud
provider (like account ID, operating system, etc), it belongs in the parent
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Google Cloud Run

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

These conventions are recommended for resources running on Cloud Run.

**Type:** `gcp.cloud_run`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

**Status**: [Experimental](../../../document-status.md)

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**type:** `heroku`

**Description:** [Heroku dyno metadata]
Expand Down
5 changes: 5 additions & 0 deletions specification/resource/semantic_conventions/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

**Status**: [Experimental](../../document-status.md)

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**type:** `container`

**Description:** A container instance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

**Status**: [Experimental](../../document-status.md)

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**type:** `deployment`

**Description:** The software deployment.
Expand Down
5 changes: 5 additions & 0 deletions specification/resource/semantic_conventions/device.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

**Status**: [Experimental](../../document-status.md)

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**type:** `device`

**Description**: The device on which the process represented by this resource is running.
Expand Down
5 changes: 5 additions & 0 deletions specification/resource/semantic_conventions/faas.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

**Status**: [Experimental](../../document-status.md)

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**type:** `faas`

**Description:** A "function as a service" aka "serverless function" instance.
Expand Down
5 changes: 5 additions & 0 deletions specification/resource/semantic_conventions/host.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

**Status**: [Experimental](../../document-status.md)

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

**type:** `host`

**Description:** A host is defined as a computing instance. For example, physical servers, virtual machines, switches or disk array.
Expand Down
5 changes: 5 additions & 0 deletions specification/resource/semantic_conventions/k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

**Status**: [Experimental](../../document-status.md)

**NOTICE** Semantic Conventions are moving to a
[new location](http://github.com/open-telemetry/semantic-conventions).

No changes to this document are allowed.

Useful resources to understand Kubernetes objects and metadata:

* [Namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/)
Expand Down
Loading